blob: 513ef0c497339ffd454cd0cc4ca9b343963dfa92 [file] [log] [blame]
Willy Tarreau6a06a402007-07-15 20:15:28 +02001 ----------------------
Willy Tarreau8317b282014-04-23 01:49:41 +02002 HAProxy
Willy Tarreau6a06a402007-07-15 20:15:28 +02003 Configuration Manual
4 ----------------------
Willy Tarreaub3066502017-11-26 19:50:17 +01005 version 1.9
Willy Tarreau6a06a402007-07-15 20:15:28 +02006 willy tarreau
Willy Tarreau65e94d12018-08-02 18:12:50 +02007 2018/08/02
Willy Tarreau6a06a402007-07-15 20:15:28 +02008
9
10This document covers the configuration language as implemented in the version
Davor Ocelice9ed2812017-12-25 17:49:28 +010011specified above. It does not provide any hints, examples, or advice. For such
Willy Tarreau0ba27502007-12-24 16:55:16 +010012documentation, please refer to the Reference Manual or the Architecture Manual.
Davor Ocelice9ed2812017-12-25 17:49:28 +010013The summary below is meant to help you find sections by name and navigate
Willy Tarreauc57f0e22009-05-10 13:12:33 +020014through the document.
Willy Tarreau6a06a402007-07-15 20:15:28 +020015
Willy Tarreauc57f0e22009-05-10 13:12:33 +020016Note to documentation contributors :
Jamie Gloudonaaa21002012-08-25 00:18:33 -040017 This document is formatted with 80 columns per line, with even number of
Willy Tarreauc57f0e22009-05-10 13:12:33 +020018 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 Tarreau62a36c42010-08-17 15:53:10 +020021 ('\') and continue on next line, indented by two characters. It is also
Davor Ocelice9ed2812017-12-25 17:49:28 +010022 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 Tarreau62a36c42010-08-17 15:53:10 +020025 please update the summary below for easier searching.
Willy Tarreauc57f0e22009-05-10 13:12:33 +020026
27
28Summary
29-------
30
311. Quick reminder about HTTP
321.1. The HTTP transaction model
331.2. HTTP request
Davor Ocelice9ed2812017-12-25 17:49:28 +0100341.2.1. The request line
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200351.2.2. The request headers
361.3. HTTP response
Davor Ocelice9ed2812017-12-25 17:49:28 +0100371.3.1. The response line
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200381.3.2. The response headers
39
402. Configuring HAProxy
412.1. Configuration file format
William Lallemandf9873ba2015-05-05 17:37:14 +0200422.2. Quoting and escaping
William Lallemandb2f07452015-05-12 14:27:13 +0200432.3. Environment variables
442.4. Time format
452.5. Examples
Willy Tarreauc57f0e22009-05-10 13:12:33 +020046
473. Global parameters
483.1. Process management and security
493.2. Performance tuning
503.3. Debugging
Krzysztof Piotr Oledzki6b35ce12010-02-01 23:35:44 +0100513.4. Userlists
Cyril Bontédc4d9032012-04-08 21:57:39 +0200523.5. Peers
Cyril Bonté307ee1e2015-09-28 23:16:06 +0200533.6. Mailers
Willy Tarreauc57f0e22009-05-10 13:12:33 +020054
554. Proxies
564.1. Proxy keywords matrix
574.2. Alphabetically sorted keywords reference
58
Davor Ocelice9ed2812017-12-25 17:49:28 +0100595. Bind and server options
Willy Tarreau086fbf52012-09-24 20:34:51 +0200605.1. Bind options
615.2. Server and default-server options
Baptiste Assmann1fa66662015-04-14 00:28:47 +0200625.3. Server DNS resolution
635.3.1. Global overview
645.3.2. The resolvers section
Willy Tarreauc57f0e22009-05-10 13:12:33 +020065
666. HTTP header manipulation
67
Willy Tarreau74ca5042013-06-11 23:12:07 +0200687. Using ACLs and fetching samples
697.1. ACL basics
707.1.1. Matching booleans
717.1.2. Matching integers
727.1.3. Matching strings
737.1.4. Matching regular expressions (regexes)
747.1.5. Matching arbitrary data blocks
757.1.6. Matching IPv4 and IPv6 addresses
767.2. Using ACLs to form conditions
777.3. Fetching samples
Thierry FOURNIER060762e2014-04-23 13:29:15 +0200787.3.1. Converters
797.3.2. Fetching samples from internal states
807.3.3. Fetching samples at Layer 4
817.3.4. Fetching samples at Layer 5
827.3.5. Fetching samples from buffer contents (Layer 6)
837.3.6. Fetching HTTP samples (Layer 7)
Willy Tarreau74ca5042013-06-11 23:12:07 +0200847.4. Pre-defined ACLs
Willy Tarreauc57f0e22009-05-10 13:12:33 +020085
868. Logging
878.1. Log levels
888.2. Log formats
898.2.1. Default log format
908.2.2. TCP log format
918.2.3. HTTP log format
William Lallemand48940402012-01-30 16:47:22 +0100928.2.4. Custom log format
Willy Tarreau5f51e1a2012-12-03 18:40:10 +0100938.2.5. Error log format
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200948.3. Advanced logging options
958.3.1. Disabling logging of external tests
968.3.2. Logging before waiting for the session to terminate
978.3.3. Raising log level upon errors
988.3.4. Disabling logging of successful connections
998.4. Timing events
1008.5. Session state at disconnection
1018.6. Non-printable characters
1028.7. Capturing HTTP cookies
1038.8. Capturing HTTP headers
1048.9. Examples of logs
105
Christopher Fauletc3fe5332016-04-07 15:30:10 +02001069. Supported filters
1079.1. Trace
1089.2. HTTP compression
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +02001099.3. Stream Processing Offload Engine (SPOE)
Christopher Fauletc3fe5332016-04-07 15:30:10 +0200110
William Lallemand86d0df02017-11-24 21:36:45 +010011110. Cache
Cyril Bonté7b888f12017-11-26 22:24:31 +010011210.1. Limitation
11310.2. Setup
11410.2.1. Cache section
11510.2.2. Proxy section
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200116
1171. Quick reminder about HTTP
118----------------------------
119
Davor Ocelice9ed2812017-12-25 17:49:28 +0100120When HAProxy is running in HTTP mode, both the request and the response are
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200121fully analyzed and indexed, thus it becomes possible to build matching criteria
122on almost anything found in the contents.
123
124However, it is important to understand how HTTP requests and responses are
125formed, and how HAProxy decomposes them. It will then become easier to write
126correct rules and to debug existing configurations.
127
128
1291.1. The HTTP transaction model
130-------------------------------
131
132The HTTP protocol is transaction-driven. This means that each request will lead
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +0100133to one and only one response. Traditionally, a TCP connection is established
Davor Ocelice9ed2812017-12-25 17:49:28 +0100134from the client to the server, a request is sent by the client through the
135connection, the server responds, and the connection is closed. A new request
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200136will involve a new connection :
137
138 [CON1] [REQ1] ... [RESP1] [CLO1] [CON2] [REQ2] ... [RESP2] [CLO2] ...
139
140In this mode, called the "HTTP close" mode, there are as many connection
141establishments as there are HTTP transactions. Since the connection is closed
142by the server after the response, the client does not need to know the content
143length.
144
145Due to the transactional nature of the protocol, it was possible to improve it
146to avoid closing a connection between two subsequent transactions. In this mode
147however, it is mandatory that the server indicates the content length for each
148response so that the client does not wait indefinitely. For this, a special
149header is used: "Content-length". This mode is called the "keep-alive" mode :
150
151 [CON] [REQ1] ... [RESP1] [REQ2] ... [RESP2] [CLO] ...
152
153Its advantages are a reduced latency between transactions, and less processing
154power required on the server side. It is generally better than the close mode,
155but not always because the clients often limit their concurrent connections to
Patrick Mezard9ec2ec42010-06-12 17:02:45 +0200156a smaller value.
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200157
Willy Tarreau95c4e142017-11-26 12:18:55 +0100158Another improvement in the communications is the pipelining mode. It still uses
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200159keep-alive, but the client does not wait for the first response to send the
160second request. This is useful for fetching large number of images composing a
161page :
162
163 [CON] [REQ1] [REQ2] ... [RESP1] [RESP2] [CLO] ...
164
165This can obviously have a tremendous benefit on performance because the network
166latency is eliminated between subsequent requests. Many HTTP agents do not
167correctly support pipelining since there is no way to associate a response with
168the corresponding request in HTTP. For this reason, it is mandatory for the
Cyril Bonté78caf842010-03-10 22:41:43 +0100169server to reply in the exact same order as the requests were received.
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200170
Willy Tarreau95c4e142017-11-26 12:18:55 +0100171The next improvement is the multiplexed mode, as implemented in HTTP/2. This
172time, each transaction is assigned a single stream identifier, and all streams
173are multiplexed over an existing connection. Many requests can be sent in
174parallel by the client, and responses can arrive in any order since they also
175carry the stream identifier.
176
Willy Tarreau70dffda2014-01-30 03:07:23 +0100177By default HAProxy operates in keep-alive mode with regards to persistent
178connections: for each connection it processes each request and response, and
179leaves the connection idle on both sides between the end of a response and the
Willy Tarreau95c4e142017-11-26 12:18:55 +0100180start of a new request. When it receives HTTP/2 connections from a client, it
181processes all the requests in parallel and leaves the connection idling,
182waiting for new requests, just as if it was a keep-alive HTTP connection.
Patrick Mezard9ec2ec42010-06-12 17:02:45 +0200183
Willy Tarreau70dffda2014-01-30 03:07:23 +0100184HAProxy supports 5 connection modes :
185 - keep alive : all requests and responses are processed (default)
186 - tunnel : only the first request and response are processed,
187 everything else is forwarded with no analysis.
188 - passive close : tunnel with "Connection: close" added in both directions.
189 - server close : the server-facing connection is closed after the response.
190 - forced close : the connection is actively closed after end of response.
191
Davor Ocelice9ed2812017-12-25 17:49:28 +0100192For HTTP/2, the connection mode resembles more the "server close" mode : given
193the independence of all streams, there is currently no place to hook the idle
Willy Tarreau95c4e142017-11-26 12:18:55 +0100194server connection after a response, so it is closed after the response. HTTP/2
195is only supported for incoming connections, not on connections going to
196servers.
197
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200198
1991.2. HTTP request
200-----------------
201
202First, let's consider this HTTP request :
203
204 Line Contents
Willy Tarreaud72758d2010-01-12 10:42:19 +0100205 number
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200206 1 GET /serv/login.php?lang=en&profile=2 HTTP/1.1
207 2 Host: www.mydomain.com
208 3 User-agent: my small browser
209 4 Accept: image/jpeg, image/gif
210 5 Accept: image/png
211
212
2131.2.1. The Request line
214-----------------------
215
216Line 1 is the "request line". It is always composed of 3 fields :
217
218 - a METHOD : GET
219 - a URI : /serv/login.php?lang=en&profile=2
220 - a version tag : HTTP/1.1
221
222All of them are delimited by what the standard calls LWS (linear white spaces),
223which are commonly spaces, but can also be tabs or line feeds/carriage returns
224followed by spaces/tabs. The method itself cannot contain any colon (':') and
225is limited to alphabetic letters. All those various combinations make it
226desirable that HAProxy performs the splitting itself rather than leaving it to
227the user to write a complex or inaccurate regular expression.
228
229The URI itself can have several forms :
230
231 - A "relative URI" :
232
233 /serv/login.php?lang=en&profile=2
234
235 It is a complete URL without the host part. This is generally what is
236 received by servers, reverse proxies and transparent proxies.
237
238 - An "absolute URI", also called a "URL" :
239
240 http://192.168.0.12:8080/serv/login.php?lang=en&profile=2
241
242 It is composed of a "scheme" (the protocol name followed by '://'), a host
243 name or address, optionally a colon (':') followed by a port number, then
244 a relative URI beginning at the first slash ('/') after the address part.
245 This is generally what proxies receive, but a server supporting HTTP/1.1
246 must accept this form too.
247
248 - a star ('*') : this form is only accepted in association with the OPTIONS
249 method and is not relayable. It is used to inquiry a next hop's
250 capabilities.
Willy Tarreaud72758d2010-01-12 10:42:19 +0100251
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200252 - an address:port combination : 192.168.0.12:80
253 This is used with the CONNECT method, which is used to establish TCP
254 tunnels through HTTP proxies, generally for HTTPS, but sometimes for
255 other protocols too.
256
257In a relative URI, two sub-parts are identified. The part before the question
258mark is called the "path". It is typically the relative path to static objects
259on the server. The part after the question mark is called the "query string".
260It is mostly used with GET requests sent to dynamic scripts and is very
261specific to the language, framework or application in use.
262
Willy Tarreau95c4e142017-11-26 12:18:55 +0100263HTTP/2 doesn't convey a version information with the request, so the version is
Davor Ocelice9ed2812017-12-25 17:49:28 +0100264assumed to be the same as the one of the underlying protocol (i.e. "HTTP/2").
Willy Tarreau95c4e142017-11-26 12:18:55 +0100265However, haproxy natively processes HTTP/1.x requests and headers, so requests
266received over an HTTP/2 connection are transcoded to HTTP/1.1 before being
267processed. This explains why they still appear as "HTTP/1.1" in haproxy's logs
268as well as in server logs.
269
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200270
2711.2.2. The request headers
272--------------------------
273
274The headers start at the second line. They are composed of a name at the
275beginning of the line, immediately followed by a colon (':'). Traditionally,
276an LWS is added after the colon but that's not required. Then come the values.
277Multiple identical headers may be folded into one single line, delimiting the
278values with commas, provided that their order is respected. This is commonly
279encountered in the "Cookie:" field. A header may span over multiple lines if
280the subsequent lines begin with an LWS. In the example in 1.2, lines 4 and 5
281define a total of 3 values for the "Accept:" header.
282
Davor Ocelice9ed2812017-12-25 17:49:28 +0100283Contrary to a common misconception, header names are not case-sensitive, and
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200284their values are not either if they refer to other header names (such as the
Willy Tarreau95c4e142017-11-26 12:18:55 +0100285"Connection:" header). In HTTP/2, header names are always sent in lower case,
286as can be seen when running in debug mode.
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200287
288The end of the headers is indicated by the first empty line. People often say
289that it's a double line feed, which is not exact, even if a double line feed
290is one valid form of empty line.
291
292Fortunately, HAProxy takes care of all these complex combinations when indexing
293headers, checking values and counting them, so there is no reason to worry
294about the way they could be written, but it is important not to accuse an
295application of being buggy if it does unusual, valid things.
296
297Important note:
Lukas Tribus23953682017-04-28 13:24:30 +0000298 As suggested by RFC7231, HAProxy normalizes headers by replacing line breaks
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200299 in the middle of headers by LWS in order to join multi-line headers. This
300 is necessary for proper analysis and helps less capable HTTP parsers to work
301 correctly and not to be fooled by such complex constructs.
302
303
3041.3. HTTP response
305------------------
306
307An HTTP response looks very much like an HTTP request. Both are called HTTP
308messages. Let's consider this HTTP response :
309
310 Line Contents
Willy Tarreaud72758d2010-01-12 10:42:19 +0100311 number
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200312 1 HTTP/1.1 200 OK
313 2 Content-length: 350
314 3 Content-Type: text/html
315
Willy Tarreau816b9792009-09-15 21:25:21 +0200316As a special case, HTTP supports so called "Informational responses" as status
317codes 1xx. These messages are special in that they don't convey any part of the
318response, they're just used as sort of a signaling message to ask a client to
Willy Tarreau5843d1a2010-02-01 15:13:32 +0100319continue to post its request for instance. In the case of a status 100 response
320the requested information will be carried by the next non-100 response message
321following the informational one. This implies that multiple responses may be
322sent to a single request, and that this only works when keep-alive is enabled
323(1xx messages are HTTP/1.1 only). HAProxy handles these messages and is able to
324correctly forward and skip them, and only process the next non-100 response. As
325such, these messages are neither logged nor transformed, unless explicitly
326state otherwise. Status 101 messages indicate that the protocol is changing
327over the same connection and that haproxy must switch to tunnel mode, just as
328if a CONNECT had occurred. Then the Upgrade header would contain additional
329information about the type of protocol the connection is switching to.
Willy Tarreau816b9792009-09-15 21:25:21 +0200330
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200331
Davor Ocelice9ed2812017-12-25 17:49:28 +01003321.3.1. The response line
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200333------------------------
334
335Line 1 is the "response line". It is always composed of 3 fields :
336
337 - a version tag : HTTP/1.1
338 - a status code : 200
339 - a reason : OK
340
341The status code is always 3-digit. The first digit indicates a general status :
Davor Ocelice9ed2812017-12-25 17:49:28 +0100342 - 1xx = informational message to be skipped (e.g. 100, 101)
343 - 2xx = OK, content is following (e.g. 200, 206)
344 - 3xx = OK, no content following (e.g. 302, 304)
345 - 4xx = error caused by the client (e.g. 401, 403, 404)
346 - 5xx = error caused by the server (e.g. 500, 502, 503)
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200347
Lukas Tribus23953682017-04-28 13:24:30 +0000348Please refer to RFC7231 for the detailed meaning of all such codes. The
Willy Tarreaud72758d2010-01-12 10:42:19 +0100349"reason" field is just a hint, but is not parsed by clients. Anything can be
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200350found there, but it's a common practice to respect the well-established
351messages. It can be composed of one or multiple words, such as "OK", "Found",
352or "Authentication Required".
353
Davor Ocelice9ed2812017-12-25 17:49:28 +0100354HAProxy may emit the following status codes by itself :
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200355
356 Code When / reason
357 200 access to stats page, and when replying to monitoring requests
358 301 when performing a redirection, depending on the configured code
359 302 when performing a redirection, depending on the configured code
360 303 when performing a redirection, depending on the configured code
Willy Tarreaub67fdc42013-03-29 19:28:11 +0100361 307 when performing a redirection, depending on the configured code
362 308 when performing a redirection, depending on the configured code
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200363 400 for an invalid or too large request
364 401 when an authentication is required to perform the action (when
365 accessing the stats page)
366 403 when a request is forbidden by a "block" ACL or "reqdeny" filter
367 408 when the request timeout strikes before the request is complete
368 500 when haproxy encounters an unrecoverable internal error, such as a
369 memory allocation failure, which should never happen
370 502 when the server returns an empty, invalid or incomplete response, or
371 when an "rspdeny" filter blocks the response.
372 503 when no server was available to handle the request, or in response to
373 monitoring requests which match the "monitor fail" condition
374 504 when the response timeout strikes before the server responds
375
376The error 4xx and 5xx codes above may be customized (see "errorloc" in section
3774.2).
378
379
3801.3.2. The response headers
381---------------------------
382
383Response headers work exactly like request headers, and as such, HAProxy uses
384the same parsing function for both. Please refer to paragraph 1.2.2 for more
385details.
386
387
3882. Configuring HAProxy
389----------------------
390
3912.1. Configuration file format
392------------------------------
Willy Tarreau6a06a402007-07-15 20:15:28 +0200393
394HAProxy's configuration process involves 3 major sources of parameters :
395
396 - the arguments from the command-line, which always take precedence
397 - the "global" section, which sets process-wide parameters
398 - the proxies sections which can take form of "defaults", "listen",
399 "frontend" and "backend".
400
Willy Tarreau0ba27502007-12-24 16:55:16 +0100401The configuration file syntax consists in lines beginning with a keyword
402referenced in this manual, optionally followed by one or several parameters
William Lallemandf9873ba2015-05-05 17:37:14 +0200403delimited by spaces.
Willy Tarreau0ba27502007-12-24 16:55:16 +0100404
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200405
William Lallemandf9873ba2015-05-05 17:37:14 +02004062.2. Quoting and escaping
407-------------------------
408
409HAProxy's configuration introduces a quoting and escaping system similar to
410many programming languages. The configuration file supports 3 types: escaping
411with a backslash, weak quoting with double quotes, and strong quoting with
412single quotes.
413
414If spaces have to be entered in strings, then they must be escaped by preceding
415them by a backslash ('\') or by quoting them. Backslashes also have to be
416escaped by doubling or strong quoting them.
417
418Escaping is achieved by preceding a special character by a backslash ('\'):
419
420 \ to mark a space and differentiate it from a delimiter
421 \# to mark a hash and differentiate it from a comment
422 \\ to use a backslash
423 \' to use a single quote and differentiate it from strong quoting
424 \" to use a double quote and differentiate it from weak quoting
425
426Weak quoting is achieved by using double quotes (""). Weak quoting prevents
427the interpretation of:
428
429 space as a parameter separator
430 ' single quote as a strong quoting delimiter
431 # hash as a comment start
432
William Lallemandb2f07452015-05-12 14:27:13 +0200433Weak quoting permits the interpretation of variables, if you want to use a non
434-interpreted dollar within a double quoted string, you should escape it with a
435backslash ("\$"), it does not work outside weak quoting.
436
437Interpretation of escaping and special characters are not prevented by weak
William Lallemandf9873ba2015-05-05 17:37:14 +0200438quoting.
439
440Strong quoting is achieved by using single quotes (''). Inside single quotes,
441nothing is interpreted, it's the efficient way to quote regexes.
442
443Quoted and escaped strings are replaced in memory by their interpreted
444equivalent, it allows you to perform concatenation.
445
446 Example:
447 # those are equivalents:
448 log-format %{+Q}o\ %t\ %s\ %{-Q}r
449 log-format "%{+Q}o %t %s %{-Q}r"
450 log-format '%{+Q}o %t %s %{-Q}r'
451 log-format "%{+Q}o %t"' %s %{-Q}r'
452 log-format "%{+Q}o %t"' %s'\ %{-Q}r
453
454 # those are equivalents:
455 reqrep "^([^\ :]*)\ /static/(.*)" \1\ /\2
456 reqrep "^([^ :]*)\ /static/(.*)" '\1 /\2'
457 reqrep "^([^ :]*)\ /static/(.*)" "\1 /\2"
458 reqrep "^([^ :]*)\ /static/(.*)" "\1\ /\2"
459
460
William Lallemandb2f07452015-05-12 14:27:13 +02004612.3. Environment variables
462--------------------------
463
464HAProxy's configuration supports environment variables. Those variables are
465interpreted only within double quotes. Variables are expanded during the
466configuration parsing. Variable names must be preceded by a dollar ("$") and
467optionally enclosed with braces ("{}") similarly to what is done in Bourne
468shell. Variable names can contain alphanumerical characters or the character
469underscore ("_") but should not start with a digit.
470
471 Example:
472
473 bind "fd@${FD_APP1}"
474
475 log "${LOCAL_SYSLOG}:514" local0 notice # send to local server
476
477 user "$HAPROXY_USER"
478
William Lallemanddaf4cd22018-04-17 16:46:13 +0200479A special variable $HAPROXY_LOCALPEER is defined at the startup of the process
480which contains the name of the local peer. (See "-L" in the management guide.)
481
William Lallemandb2f07452015-05-12 14:27:13 +0200482
4832.4. Time format
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200484----------------
485
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +0100486Some parameters involve values representing time, such as timeouts. These
Willy Tarreau0ba27502007-12-24 16:55:16 +0100487values are generally expressed in milliseconds (unless explicitly stated
488otherwise) but may be expressed in any other unit by suffixing the unit to the
489numeric value. It is important to consider this because it will not be repeated
490for every keyword. Supported units are :
491
492 - us : microseconds. 1 microsecond = 1/1000000 second
493 - ms : milliseconds. 1 millisecond = 1/1000 second. This is the default.
494 - s : seconds. 1s = 1000ms
495 - m : minutes. 1m = 60s = 60000ms
496 - h : hours. 1h = 60m = 3600s = 3600000ms
497 - d : days. 1d = 24h = 1440m = 86400s = 86400000ms
498
499
Lukas Tribusaa83a312017-03-21 09:25:09 +00005002.5. Examples
Patrick Mezard35da19c2010-06-12 17:02:47 +0200501-------------
502
503 # Simple configuration for an HTTP proxy listening on port 80 on all
504 # interfaces and forwarding requests to a single backend "servers" with a
505 # single server "server1" listening on 127.0.0.1:8000
506 global
507 daemon
508 maxconn 256
509
510 defaults
511 mode http
512 timeout connect 5000ms
513 timeout client 50000ms
514 timeout server 50000ms
515
516 frontend http-in
517 bind *:80
518 default_backend servers
519
520 backend servers
521 server server1 127.0.0.1:8000 maxconn 32
522
523
524 # The same configuration defined with a single listen block. Shorter but
525 # less expressive, especially in HTTP mode.
526 global
527 daemon
528 maxconn 256
529
530 defaults
531 mode http
532 timeout connect 5000ms
533 timeout client 50000ms
534 timeout server 50000ms
535
536 listen http-in
537 bind *:80
538 server server1 127.0.0.1:8000 maxconn 32
539
540
541Assuming haproxy is in $PATH, test these configurations in a shell with:
542
Willy Tarreauccb289d2010-12-11 20:19:38 +0100543 $ sudo haproxy -f configuration.conf -c
Patrick Mezard35da19c2010-06-12 17:02:47 +0200544
545
Willy Tarreauc57f0e22009-05-10 13:12:33 +02005463. Global parameters
Willy Tarreau6a06a402007-07-15 20:15:28 +0200547--------------------
548
549Parameters in the "global" section are process-wide and often OS-specific. They
550are generally set once for all and do not need being changed once correct. Some
551of them have command-line equivalents.
552
553The following keywords are supported in the "global" section :
554
555 * Process management and security
Emeric Brunc8e8d122012-10-02 18:42:10 +0200556 - ca-base
Willy Tarreau6a06a402007-07-15 20:15:28 +0200557 - chroot
Emeric Brunc8e8d122012-10-02 18:42:10 +0200558 - crt-base
Baptiste Assmann3493d0f2015-10-12 20:21:23 +0200559 - cpu-map
Willy Tarreau6a06a402007-07-15 20:15:28 +0200560 - daemon
Baptiste Assmann3493d0f2015-10-12 20:21:23 +0200561 - description
562 - deviceatlas-json-file
563 - deviceatlas-log-level
564 - deviceatlas-separator
565 - deviceatlas-properties-cookie
Simon Horman98637e52014-06-20 12:30:16 +0900566 - external-check
Willy Tarreau6a06a402007-07-15 20:15:28 +0200567 - gid
568 - group
Cyril Bonté203ec5a2017-03-23 22:44:13 +0100569 - hard-stop-after
Willy Tarreau6a06a402007-07-15 20:15:28 +0200570 - log
Baptiste Assmann3493d0f2015-10-12 20:21:23 +0200571 - log-tag
Joe Williamsdf5b38f2010-12-29 17:05:48 +0100572 - log-send-hostname
Baptiste Assmann3493d0f2015-10-12 20:21:23 +0200573 - lua-load
Willy Tarreau6a06a402007-07-15 20:15:28 +0200574 - nbproc
Christopher Fauletbe0faa22017-08-29 15:37:10 +0200575 - nbthread
Baptiste Assmann3493d0f2015-10-12 20:21:23 +0200576 - node
Willy Tarreau6a06a402007-07-15 20:15:28 +0200577 - pidfile
Willy Tarreau1d549722016-02-16 12:41:57 +0100578 - presetenv
579 - resetenv
Willy Tarreau6a06a402007-07-15 20:15:28 +0200580 - uid
581 - ulimit-n
582 - user
Willy Tarreau1d549722016-02-16 12:41:57 +0100583 - setenv
Willy Tarreaufbee7132007-10-18 13:53:22 +0200584 - stats
Baptiste Assmann3493d0f2015-10-12 20:21:23 +0200585 - ssl-default-bind-ciphers
586 - ssl-default-bind-options
587 - ssl-default-server-ciphers
588 - ssl-default-server-options
589 - ssl-dh-param-file
Emeric Brun850efd52014-01-29 12:24:34 +0100590 - ssl-server-verify
Willy Tarreauceb24bc2010-11-09 12:46:41 +0100591 - unix-bind
Willy Tarreau1d549722016-02-16 12:41:57 +0100592 - unsetenv
Thomas Holmesdb04f192015-05-18 13:21:39 +0100593 - 51degrees-data-file
594 - 51degrees-property-name-list
Dragan Dosen93b38d92015-06-29 16:43:25 +0200595 - 51degrees-property-separator
Dragan Dosenae6d39a2015-06-29 16:43:27 +0200596 - 51degrees-cache-size
scientiamobiled0027ed2016-11-04 10:55:08 +0100597 - wurfl-data-file
598 - wurfl-information-list
599 - wurfl-information-list-separator
600 - wurfl-engine-mode
601 - wurfl-cache-size
602 - wurfl-useragent-priority
Willy Tarreaud72758d2010-01-12 10:42:19 +0100603
Willy Tarreau6a06a402007-07-15 20:15:28 +0200604 * Performance tuning
Willy Tarreau1746eec2014-04-25 10:46:47 +0200605 - max-spread-checks
Willy Tarreau6a06a402007-07-15 20:15:28 +0200606 - maxconn
Willy Tarreau81c25d02011-09-07 15:17:21 +0200607 - maxconnrate
William Lallemandd85f9172012-11-09 17:05:39 +0100608 - maxcomprate
William Lallemand072a2bf2012-11-20 17:01:01 +0100609 - maxcompcpuusage
Willy Tarreauff4f82d2009-02-06 11:28:13 +0100610 - maxpipes
Willy Tarreau93e7c002013-10-07 18:51:07 +0200611 - maxsessrate
Willy Tarreau403edff2012-09-06 11:58:37 +0200612 - maxsslconn
Willy Tarreaue43d5322013-10-07 20:01:52 +0200613 - maxsslrate
Baptiste Assmann3493d0f2015-10-12 20:21:23 +0200614 - maxzlibmem
Willy Tarreau6a06a402007-07-15 20:15:28 +0200615 - noepoll
616 - nokqueue
617 - nopoll
Willy Tarreauff4f82d2009-02-06 11:28:13 +0100618 - nosplice
Jarno Huuskonen0e82b922014-04-12 18:22:19 +0300619 - nogetaddrinfo
Lukas Tribusa0bcbdc2016-09-12 21:42:20 +0000620 - noreuseport
Willy Tarreaufe255b72007-10-14 23:09:26 +0200621 - spread-checks
Baptiste Assmann5626f482015-08-23 10:00:10 +0200622 - server-state-base
Baptiste Assmannef1f0fc2015-08-23 10:06:39 +0200623 - server-state-file
Grant Zhang872f9c22017-01-21 01:10:18 +0000624 - ssl-engine
Grant Zhangfa6c7ee2017-01-14 01:42:15 +0000625 - ssl-mode-async
Baptiste Assmann3493d0f2015-10-12 20:21:23 +0200626 - tune.buffers.limit
627 - tune.buffers.reserve
Willy Tarreau27a674e2009-08-17 07:23:33 +0200628 - tune.bufsize
Willy Tarreau43961d52010-10-04 20:39:20 +0200629 - tune.chksize
William Lallemandf3747832012-11-09 12:33:10 +0100630 - tune.comp.maxlevel
Willy Tarreaufe20e5b2017-07-27 11:42:14 +0200631 - tune.h2.header-table-size
Willy Tarreaue6baec02017-07-27 11:45:11 +0200632 - tune.h2.initial-window-size
Willy Tarreau5242ef82017-07-27 11:47:28 +0200633 - tune.h2.max-concurrent-streams
Willy Tarreau193b8c62012-11-22 00:17:38 +0100634 - tune.http.cookielen
Stéphane Cottin23e9e932017-05-18 08:58:41 +0200635 - tune.http.logurilen
Willy Tarreauac1932d2011-10-24 19:14:41 +0200636 - tune.http.maxhdr
Willy Tarreau7e312732014-02-12 16:35:14 +0100637 - tune.idletimer
Thierry FOURNIER90da1912015-03-05 11:17:06 +0100638 - tune.lua.forced-yield
Willy Tarreau32f61e22015-03-18 17:54:59 +0100639 - tune.lua.maxmem
Thierry FOURNIER90da1912015-03-05 11:17:06 +0100640 - tune.lua.session-timeout
641 - tune.lua.task-timeout
Thierry FOURNIER7dd784b2015-10-01 14:49:33 +0200642 - tune.lua.service-timeout
Willy Tarreaua0250ba2008-01-06 11:22:57 +0100643 - tune.maxaccept
644 - tune.maxpollevents
Willy Tarreau27a674e2009-08-17 07:23:33 +0200645 - tune.maxrewrite
Willy Tarreauf3045d22015-04-29 16:24:50 +0200646 - tune.pattern.cache-size
Willy Tarreaubd9a0a72011-10-23 21:14:29 +0200647 - tune.pipesize
Willy Tarreaue803de22010-01-21 17:43:04 +0100648 - tune.rcvbuf.client
649 - tune.rcvbuf.server
Willy Tarreaub22fc302015-12-14 12:04:35 +0100650 - tune.recv_enough
Olivier Houchard1599b802018-05-24 18:59:04 +0200651 - tune.runqueue-depth
Willy Tarreaue803de22010-01-21 17:43:04 +0100652 - tune.sndbuf.client
653 - tune.sndbuf.server
Willy Tarreau6ec58db2012-11-16 16:32:15 +0100654 - tune.ssl.cachesize
Willy Tarreaubfd59462013-02-21 07:46:09 +0100655 - tune.ssl.lifetime
Emeric Brun8dc60392014-05-09 13:52:00 +0200656 - tune.ssl.force-private-cache
Willy Tarreaubfd59462013-02-21 07:46:09 +0100657 - tune.ssl.maxrecord
Remi Gacognef46cd6e2014-06-12 14:58:40 +0200658 - tune.ssl.default-dh-param
Christopher Faulet31af49d2015-06-09 17:29:50 +0200659 - tune.ssl.ssl-ctx-cache-size
Thierry FOURNIER5bf77322017-02-25 12:45:22 +0100660 - tune.ssl.capture-cipherlist-size
Thierry FOURNIER4834bc72015-06-06 19:29:07 +0200661 - tune.vars.global-max-size
Christopher Fauletff2613e2016-11-09 11:36:17 +0100662 - tune.vars.proc-max-size
Thierry FOURNIER4834bc72015-06-06 19:29:07 +0200663 - tune.vars.reqres-max-size
664 - tune.vars.sess-max-size
665 - tune.vars.txn-max-size
William Lallemanda509e4c2012-11-07 16:54:34 +0100666 - tune.zlib.memlevel
667 - tune.zlib.windowsize
Willy Tarreaud72758d2010-01-12 10:42:19 +0100668
Willy Tarreau6a06a402007-07-15 20:15:28 +0200669 * Debugging
670 - debug
671 - quiet
Willy Tarreau6a06a402007-07-15 20:15:28 +0200672
673
Willy Tarreauc57f0e22009-05-10 13:12:33 +02006743.1. Process management and security
Willy Tarreau6a06a402007-07-15 20:15:28 +0200675------------------------------------
676
Emeric Brunc8e8d122012-10-02 18:42:10 +0200677ca-base <dir>
678 Assigns a default directory to fetch SSL CA certificates and CRLs from when a
Emeric Brunfd33a262012-10-11 16:28:27 +0200679 relative path is used with "ca-file" or "crl-file" directives. Absolute
680 locations specified in "ca-file" and "crl-file" prevail and ignore "ca-base".
Emeric Brunc8e8d122012-10-02 18:42:10 +0200681
Willy Tarreau6a06a402007-07-15 20:15:28 +0200682chroot <jail dir>
683 Changes current directory to <jail dir> and performs a chroot() there before
684 dropping privileges. This increases the security level in case an unknown
685 vulnerability would be exploited, since it would make it very hard for the
686 attacker to exploit the system. This only works when the process is started
687 with superuser privileges. It is important to ensure that <jail_dir> is both
Davor Ocelice9ed2812017-12-25 17:49:28 +0100688 empty and non-writable to anyone.
Willy Tarreaud72758d2010-01-12 10:42:19 +0100689
Christopher Fauletcb6a9452017-11-22 16:50:41 +0100690cpu-map [auto:]<process-set>[/<thread-set>] <cpu-set>...
691 On Linux 2.6 and above, it is possible to bind a process or a thread to a
692 specific CPU set. This means that the process or the thread will never run on
693 other CPUs. The "cpu-map" directive specifies CPU sets for process or thread
694 sets. The first argument is a process set, eventually followed by a thread
695 set. These sets have the format
696
697 all | odd | even | number[-[number]]
698
699 <number>> must be a number between 1 and 32 or 64, depending on the machine's
Davor Ocelice9ed2812017-12-25 17:49:28 +0100700 word size. Any process IDs above nbproc and any thread IDs above nbthread are
Christopher Fauletcb6a9452017-11-22 16:50:41 +0100701 ignored. It is possible to specify a range with two such number delimited by
702 a dash ('-'). It also is possible to specify all processes at once using
Christopher Faulet1dcb9cb2017-11-22 10:24:40 +0100703 "all", only odd numbers using "odd" or even numbers using "even", just like
704 with the "bind-process" directive. The second and forthcoming arguments are
Davor Ocelice9ed2812017-12-25 17:49:28 +0100705 CPU sets. Each CPU set is either a unique number between 0 and 31 or 63 or a
Christopher Faulet1dcb9cb2017-11-22 10:24:40 +0100706 range with two such numbers delimited by a dash ('-'). Multiple CPU numbers
Christopher Fauletcb6a9452017-11-22 16:50:41 +0100707 or ranges may be specified, and the processes or threads will be allowed to
Davor Ocelice9ed2812017-12-25 17:49:28 +0100708 bind to all of them. Obviously, multiple "cpu-map" directives may be
Christopher Fauletcb6a9452017-11-22 16:50:41 +0100709 specified. Each "cpu-map" directive will replace the previous ones when they
710 overlap. A thread will be bound on the intersection of its mapping and the
711 one of the process on which it is attached. If the intersection is null, no
712 specific binding will be set for the thread.
Willy Tarreaufc6c0322012-11-16 16:12:27 +0100713
Christopher Fauletff4121f2017-11-22 16:38:49 +0100714 Ranges can be partially defined. The higher bound can be omitted. In such
715 case, it is replaced by the corresponding maximum value, 32 or 64 depending
716 on the machine's word size.
717
Christopher Faulet26028f62017-11-22 15:01:51 +0100718 The prefix "auto:" can be added before the process set to let HAProxy
Christopher Fauletcb6a9452017-11-22 16:50:41 +0100719 automatically bind a process or a thread to a CPU by incrementing
720 process/thread and CPU sets. To be valid, both sets must have the same
721 size. No matter the declaration order of the CPU sets, it will be bound from
722 the lowest to the highest bound. Having a process and a thread range with the
723 "auto:" prefix is not supported. Only one range is supported, the other one
724 must be a fixed number.
Christopher Faulet26028f62017-11-22 15:01:51 +0100725
726 Examples:
Christopher Fauletcb6a9452017-11-22 16:50:41 +0100727 cpu-map 1-4 0-3 # bind processes 1 to 4 on the first 4 CPUs
728
729 cpu-map 1/all 0-3 # bind all threads of the first process on the
730 # first 4 CPUs
731
732 cpu-map 1- 0- # will be replaced by "cpu-map 1-64 0-63"
733 # or "cpu-map 1-32 0-31" depending on the machine's
734 # word size.
735
Christopher Faulet26028f62017-11-22 15:01:51 +0100736 # all these lines bind the process 1 to the cpu 0, the process 2 to cpu 1
Christopher Fauletcb6a9452017-11-22 16:50:41 +0100737 # and so on.
Christopher Faulet26028f62017-11-22 15:01:51 +0100738 cpu-map auto:1-4 0-3
739 cpu-map auto:1-4 0-1 2-3
740 cpu-map auto:1-4 3 2 1 0
741
Christopher Fauletcb6a9452017-11-22 16:50:41 +0100742 # all these lines bind the thread 1 to the cpu 0, the thread 2 to cpu 1
743 # and so on.
744 cpu-map auto:1/1-4 0-3
745 cpu-map auto:1/1-4 0-1 2-3
746 cpu-map auto:1/1-4 3 2 1 0
747
Davor Ocelice9ed2812017-12-25 17:49:28 +0100748 # bind each process to exactly one CPU using all/odd/even keyword
Christopher Faulet26028f62017-11-22 15:01:51 +0100749 cpu-map auto:all 0-63
750 cpu-map auto:even 0-31
751 cpu-map auto:odd 32-63
752
753 # invalid cpu-map because process and CPU sets have different sizes.
754 cpu-map auto:1-4 0 # invalid
755 cpu-map auto:1 0-3 # invalid
756
Christopher Fauletcb6a9452017-11-22 16:50:41 +0100757 # invalid cpu-map because automatic binding is used with a process range
758 # and a thread range.
759 cpu-map auto:all/all 0 # invalid
760 cpu-map auto:all/1-4 0 # invalid
761 cpu-map auto:1-4/all 0 # invalid
762
Emeric Brunc8e8d122012-10-02 18:42:10 +0200763crt-base <dir>
764 Assigns a default directory to fetch SSL certificates from when a relative
765 path is used with "crtfile" directives. Absolute locations specified after
766 "crtfile" prevail and ignore "crt-base".
767
Willy Tarreau6a06a402007-07-15 20:15:28 +0200768daemon
769 Makes the process fork into background. This is the recommended mode of
770 operation. It is equivalent to the command line "-D" argument. It can be
Lukas Tribusf46bf952017-11-21 12:39:34 +0100771 disabled by the command line "-db" argument. This option is ignored in
772 systemd mode.
Willy Tarreau6a06a402007-07-15 20:15:28 +0200773
David Carlier8167f302015-06-01 13:50:06 +0200774deviceatlas-json-file <path>
775 Sets the path of the DeviceAtlas JSON data file to be loaded by the API.
Davor Ocelice9ed2812017-12-25 17:49:28 +0100776 The path must be a valid JSON data file and accessible by HAProxy process.
David Carlier8167f302015-06-01 13:50:06 +0200777
778deviceatlas-log-level <value>
Davor Ocelice9ed2812017-12-25 17:49:28 +0100779 Sets the level of information returned by the API. This directive is
David Carlier8167f302015-06-01 13:50:06 +0200780 optional and set to 0 by default if not set.
781
782deviceatlas-separator <char>
783 Sets the character separator for the API properties results. This directive
784 is optional and set to | by default if not set.
785
Cyril Bonté0306c4a2015-10-26 22:37:38 +0100786deviceatlas-properties-cookie <name>
Cyril Bonté307ee1e2015-09-28 23:16:06 +0200787 Sets the client cookie's name used for the detection if the DeviceAtlas
788 Client-side component was used during the request. This directive is optional
789 and set to DAPROPS by default if not set.
David Carlier29b3ca32015-09-25 14:09:21 +0100790
Simon Horman98637e52014-06-20 12:30:16 +0900791external-check
792 Allows the use of an external agent to perform health checks.
793 This is disabled by default as a security precaution.
794 See "option external-check".
795
Willy Tarreau6a06a402007-07-15 20:15:28 +0200796gid <number>
797 Changes the process' group ID to <number>. It is recommended that the group
798 ID is dedicated to HAProxy or to a small set of similar daemons. HAProxy must
799 be started with a user belonging to this group, or with superuser privileges.
Michael Schererab012dd2013-01-12 18:35:19 +0100800 Note that if haproxy is started from a user having supplementary groups, it
801 will only be able to drop these groups if started with superuser privileges.
Willy Tarreau6a06a402007-07-15 20:15:28 +0200802 See also "group" and "uid".
Willy Tarreaud72758d2010-01-12 10:42:19 +0100803
Cyril Bonté203ec5a2017-03-23 22:44:13 +0100804hard-stop-after <time>
805 Defines the maximum time allowed to perform a clean soft-stop.
806
807 Arguments :
808 <time> is the maximum time (by default in milliseconds) for which the
809 instance will remain alive when a soft-stop is received via the
810 SIGUSR1 signal.
811
812 This may be used to ensure that the instance will quit even if connections
813 remain opened during a soft-stop (for example with long timeouts for a proxy
814 in tcp mode). It applies both in TCP and HTTP mode.
815
816 Example:
817 global
818 hard-stop-after 30s
819
Willy Tarreau6a06a402007-07-15 20:15:28 +0200820group <group name>
821 Similar to "gid" but uses the GID of group name <group name> from /etc/group.
822 See also "gid" and "user".
Willy Tarreaud72758d2010-01-12 10:42:19 +0100823
Dragan Dosen7ad31542015-09-28 17:16:47 +0200824log <address> [len <length>] [format <format>] <facility> [max level [min level]]
Cyril Bonté3e954872018-03-20 23:30:27 +0100825 Adds a global syslog server. Several global servers can be defined. They
Davor Ocelice9ed2812017-12-25 17:49:28 +0100826 will receive logs for starts and exits, as well as all logs from proxies
Robert Tsai81ae1952007-12-05 10:47:29 +0100827 configured with "log global".
828
829 <address> can be one of:
830
Willy Tarreau2769aa02007-12-27 18:26:09 +0100831 - An IPv4 address optionally followed by a colon and a UDP port. If
Robert Tsai81ae1952007-12-05 10:47:29 +0100832 no port is specified, 514 is used by default (the standard syslog
833 port).
834
David du Colombier24bb5f52011-03-17 10:40:23 +0100835 - An IPv6 address followed by a colon and optionally a UDP port. If
836 no port is specified, 514 is used by default (the standard syslog
837 port).
838
Robert Tsai81ae1952007-12-05 10:47:29 +0100839 - A filesystem path to a UNIX domain socket, keeping in mind
840 considerations for chroot (be sure the path is accessible inside
841 the chroot) and uid/gid (be sure the path is appropriately
Davor Ocelice9ed2812017-12-25 17:49:28 +0100842 writable).
Robert Tsai81ae1952007-12-05 10:47:29 +0100843
William Lallemandb2f07452015-05-12 14:27:13 +0200844 You may want to reference some environment variables in the address
845 parameter, see section 2.3 about environment variables.
Willy Tarreaudad36a32013-03-11 01:20:04 +0100846
Willy Tarreau18324f52014-06-27 18:10:07 +0200847 <length> is an optional maximum line length. Log lines larger than this value
848 will be truncated before being sent. The reason is that syslog
849 servers act differently on log line length. All servers support the
850 default value of 1024, but some servers simply drop larger lines
851 while others do log them. If a server supports long lines, it may
852 make sense to set this value here in order to avoid truncating long
853 lines. Similarly, if a server drops long lines, it is preferable to
854 truncate them before sending them. Accepted values are 80 to 65535
855 inclusive. The default value of 1024 is generally fine for all
856 standard usages. Some specific cases of long captures or
Davor Ocelice9ed2812017-12-25 17:49:28 +0100857 JSON-formatted logs may require larger values. You may also need to
858 increase "tune.http.logurilen" if your request URIs are truncated.
Willy Tarreau18324f52014-06-27 18:10:07 +0200859
Dragan Dosen7ad31542015-09-28 17:16:47 +0200860 <format> is the log format used when generating syslog messages. It may be
861 one of the following :
862
863 rfc3164 The RFC3164 syslog message format. This is the default.
864 (https://tools.ietf.org/html/rfc3164)
865
866 rfc5424 The RFC5424 syslog message format.
867 (https://tools.ietf.org/html/rfc5424)
868
Robert Tsai81ae1952007-12-05 10:47:29 +0100869 <facility> must be one of the 24 standard syslog facilities :
Willy Tarreau6a06a402007-07-15 20:15:28 +0200870
871 kern user mail daemon auth syslog lpr news
872 uucp cron auth2 ftp ntp audit alert cron2
873 local0 local1 local2 local3 local4 local5 local6 local7
874
875 An optional level can be specified to filter outgoing messages. By default,
Willy Tarreauf7edefa2009-05-10 17:20:05 +0200876 all messages are sent. If a maximum level is specified, only messages with a
877 severity at least as important as this level will be sent. An optional minimum
878 level can be specified. If it is set, logs emitted with a more severe level
879 than this one will be capped to this level. This is used to avoid sending
880 "emerg" messages on all terminals on some default syslog configurations.
881 Eight levels are known :
Willy Tarreau6a06a402007-07-15 20:15:28 +0200882
Cyril Bontédc4d9032012-04-08 21:57:39 +0200883 emerg alert crit err warning notice info debug
Willy Tarreau6a06a402007-07-15 20:15:28 +0200884
Joe Williamsdf5b38f2010-12-29 17:05:48 +0100885log-send-hostname [<string>]
886 Sets the hostname field in the syslog header. If optional "string" parameter
887 is set the header is set to the string contents, otherwise uses the hostname
888 of the system. Generally used if one is not relaying logs through an
889 intermediate syslog server or for simply customizing the hostname printed in
890 the logs.
891
Kevinm48936af2010-12-22 16:08:21 +0000892log-tag <string>
893 Sets the tag field in the syslog header to this string. It defaults to the
894 program name as launched from the command line, which usually is "haproxy".
895 Sometimes it can be useful to differentiate between multiple processes
Willy Tarreau094af4e2015-01-07 15:03:42 +0100896 running on the same host. See also the per-proxy "log-tag" directive.
Kevinm48936af2010-12-22 16:08:21 +0000897
Thierry FOURNIER90da1912015-03-05 11:17:06 +0100898lua-load <file>
899 This global directive loads and executes a Lua file. This directive can be
900 used multiple times.
901
William Lallemand4cfede82017-11-24 22:02:34 +0100902master-worker [no-exit-on-failure]
William Lallemande202b1e2017-06-01 17:38:56 +0200903 Master-worker mode. It is equivalent to the command line "-W" argument.
904 This mode will launch a "master" which will monitor the "workers". Using
905 this mode, you can reload HAProxy directly by sending a SIGUSR2 signal to
Davor Ocelice9ed2812017-12-25 17:49:28 +0100906 the master. The master-worker mode is compatible either with the foreground
William Lallemande202b1e2017-06-01 17:38:56 +0200907 or daemon mode. It is recommended to use this mode with multiprocess and
908 systemd.
William Lallemand4cfede82017-11-24 22:02:34 +0100909 By default, if a worker exits with a bad return code, in the case of a
910 segfault for example, all workers will be killed, and the master will leave.
911 It is convenient to combine this behavior with Restart=on-failure in a
912 systemd unit file in order to relaunch the whole process. If you don't want
913 this behavior, you must use the keyword "no-exit-on-failure".
William Lallemande202b1e2017-06-01 17:38:56 +0200914
William Lallemand4cfede82017-11-24 22:02:34 +0100915 See also "-W" in the management guide.
William Lallemande202b1e2017-06-01 17:38:56 +0200916
Willy Tarreau6a06a402007-07-15 20:15:28 +0200917nbproc <number>
918 Creates <number> processes when going daemon. This requires the "daemon"
919 mode. By default, only one process is created, which is the recommended mode
920 of operation. For systems limited to small sets of file descriptors per
921 process, it may be needed to fork multiple daemons. USING MULTIPLE PROCESSES
922 IS HARDER TO DEBUG AND IS REALLY DISCOURAGED. See also "daemon".
923
Christopher Fauletbe0faa22017-08-29 15:37:10 +0200924nbthread <number>
925 This setting is only available when support for threads was built in. It
926 creates <number> threads for each created processes. It means if HAProxy is
927 started in foreground, it only creates <number> threads for the first
928 process. FOR NOW, THREADS SUPPORT IN HAPROXY IS HIGHLY EXPERIMENTAL AND IT
929 MUST BE ENABLED WITH CAUTION AND AT YOUR OWN RISK. See also "nbproc".
930
Willy Tarreau6a06a402007-07-15 20:15:28 +0200931pidfile <pidfile>
Davor Ocelice9ed2812017-12-25 17:49:28 +0100932 Writes PIDs of all daemons into file <pidfile>. This option is equivalent to
Willy Tarreau6a06a402007-07-15 20:15:28 +0200933 the "-p" command line argument. The file must be accessible to the user
934 starting the process. See also "daemon".
935
Willy Tarreau1d549722016-02-16 12:41:57 +0100936presetenv <name> <value>
937 Sets environment variable <name> to value <value>. If the variable exists, it
938 is NOT overwritten. The changes immediately take effect so that the next line
939 in the configuration file sees the new value. See also "setenv", "resetenv",
940 and "unsetenv".
941
942resetenv [<name> ...]
943 Removes all environment variables except the ones specified in argument. It
944 allows to use a clean controlled environment before setting new values with
945 setenv or unsetenv. Please note that some internal functions may make use of
946 some environment variables, such as time manipulation functions, but also
947 OpenSSL or even external checks. This must be used with extreme care and only
948 after complete validation. The changes immediately take effect so that the
949 next line in the configuration file sees the new environment. See also
950 "setenv", "presetenv", and "unsetenv".
951
Christopher Fauletff4121f2017-11-22 16:38:49 +0100952stats bind-process [ all | odd | even | <process_num>[-[process_num>]] ] ...
Willy Tarreau35b7b162012-10-22 23:17:18 +0200953 Limits the stats socket to a certain set of processes numbers. By default the
954 stats socket is bound to all processes, causing a warning to be emitted when
955 nbproc is greater than 1 because there is no way to select the target process
956 when connecting. However, by using this setting, it becomes possible to pin
957 the stats socket to a specific set of processes, typically the first one. The
958 warning will automatically be disabled when this setting is used, whatever
Willy Tarreaua9db57e2013-01-18 11:29:29 +0100959 the number of processes used. The maximum process ID depends on the machine's
Christopher Fauletff4121f2017-11-22 16:38:49 +0100960 word size (32 or 64). Ranges can be partially defined. The higher bound can
961 be omitted. In such case, it is replaced by the corresponding maximum
962 value. A better option consists in using the "process" setting of the "stats
963 socket" line to force the process on each line.
Willy Tarreau35b7b162012-10-22 23:17:18 +0200964
Baptiste Assmann5626f482015-08-23 10:00:10 +0200965server-state-base <directory>
966 Specifies the directory prefix to be prepended in front of all servers state
Baptiste Assmann01c6cc32015-08-23 11:45:29 +0200967 file names which do not start with a '/'. See also "server-state-file",
968 "load-server-state-from-file" and "server-state-file-name".
Baptiste Assmannef1f0fc2015-08-23 10:06:39 +0200969
970server-state-file <file>
971 Specifies the path to the file containing state of servers. If the path starts
972 with a slash ('/'), it is considered absolute, otherwise it is considered
973 relative to the directory specified using "server-state-base" (if set) or to
974 the current directory. Before reloading HAProxy, it is possible to save the
975 servers' current state using the stats command "show servers state". The
976 output of this command must be written in the file pointed by <file>. When
977 starting up, before handling traffic, HAProxy will read, load and apply state
978 for each server found in the file and available in its current running
Baptiste Assmann01c6cc32015-08-23 11:45:29 +0200979 configuration. See also "server-state-base" and "show servers state",
980 "load-server-state-from-file" and "server-state-file-name"
Baptiste Assmann5626f482015-08-23 10:00:10 +0200981
Willy Tarreau1d549722016-02-16 12:41:57 +0100982setenv <name> <value>
983 Sets environment variable <name> to value <value>. If the variable exists, it
984 is overwritten. The changes immediately take effect so that the next line in
985 the configuration file sees the new value. See also "presetenv", "resetenv",
986 and "unsetenv".
987
Willy Tarreau610f04b2014-02-13 11:36:41 +0100988ssl-default-bind-ciphers <ciphers>
989 This setting is only available when support for OpenSSL was built in. It sets
990 the default string describing the list of cipher algorithms ("cipher suite")
Jarno Huuskonen0e82b922014-04-12 18:22:19 +0300991 that are negotiated during the SSL/TLS handshake for all "bind" lines which
Willy Tarreau610f04b2014-02-13 11:36:41 +0100992 do not explicitly define theirs. The format of the string is defined in
993 "man 1 ciphers" from OpenSSL man pages, and can be for instance a string such
994 as "AES:ALL:!aNULL:!eNULL:+RC4:@STRENGTH" (without quotes). Please check the
995 "bind" keyword for more information.
996
Emeric Brun2c86cbf2014-10-30 15:56:50 +0100997ssl-default-bind-options [<option>]...
998 This setting is only available when support for OpenSSL was built in. It sets
999 default ssl-options to force on all "bind" lines. Please check the "bind"
1000 keyword to see available options.
1001
1002 Example:
1003 global
Emmanuel Hocdete1c722b2017-03-31 15:02:54 +02001004 ssl-default-bind-options ssl-min-ver TLSv1.0 no-tls-tickets
Emeric Brun2c86cbf2014-10-30 15:56:50 +01001005
Willy Tarreau610f04b2014-02-13 11:36:41 +01001006ssl-default-server-ciphers <ciphers>
1007 This setting is only available when support for OpenSSL was built in. It
1008 sets the default string describing the list of cipher algorithms that are
Jarno Huuskonen0e82b922014-04-12 18:22:19 +03001009 negotiated during the SSL/TLS handshake with the server, for all "server"
Willy Tarreau610f04b2014-02-13 11:36:41 +01001010 lines which do not explicitly define theirs. The format of the string is
1011 defined in "man 1 ciphers". Please check the "server" keyword for more
1012 information.
1013
Emeric Brun2c86cbf2014-10-30 15:56:50 +01001014ssl-default-server-options [<option>]...
1015 This setting is only available when support for OpenSSL was built in. It sets
1016 default ssl-options to force on all "server" lines. Please check the "server"
1017 keyword to see available options.
1018
Remi Gacogne47783ef2015-05-29 15:53:22 +02001019ssl-dh-param-file <file>
1020 This setting is only available when support for OpenSSL was built in. It sets
1021 the default DH parameters that are used during the SSL/TLS handshake when
1022 ephemeral Diffie-Hellman (DHE) key exchange is used, for all "bind" lines
Davor Ocelice9ed2812017-12-25 17:49:28 +01001023 which do not explicitly define theirs. It will be overridden by custom DH
Remi Gacogne47783ef2015-05-29 15:53:22 +02001024 parameters found in a bind certificate file if any. If custom DH parameters
Cyril Bonté307ee1e2015-09-28 23:16:06 +02001025 are not specified either by using ssl-dh-param-file or by setting them
1026 directly in the certificate file, pre-generated DH parameters of the size
1027 specified by tune.ssl.default-dh-param will be used. Custom parameters are
1028 known to be more secure and therefore their use is recommended.
Remi Gacogne47783ef2015-05-29 15:53:22 +02001029 Custom DH parameters may be generated by using the OpenSSL command
1030 "openssl dhparam <size>", where size should be at least 2048, as 1024-bit DH
1031 parameters should not be considered secure anymore.
1032
Emeric Brun850efd52014-01-29 12:24:34 +01001033ssl-server-verify [none|required]
1034 The default behavior for SSL verify on servers side. If specified to 'none',
1035 servers certificates are not verified. The default is 'required' except if
1036 forced using cmdline option '-dV'.
1037
Willy Tarreauabb175f2012-09-24 12:43:26 +02001038stats socket [<address:port>|<path>] [param*]
1039 Binds a UNIX socket to <path> or a TCPv4/v6 address to <address:port>.
1040 Connections to this socket will return various statistics outputs and even
1041 allow some commands to be issued to change some runtime settings. Please
Willy Tarreau1af20c72017-06-23 16:01:14 +02001042 consult section 9.3 "Unix Socket commands" of Management Guide for more
Kevin Decherf949c7202015-10-13 23:26:44 +02001043 details.
Willy Tarreau6162db22009-10-10 17:13:00 +02001044
Willy Tarreauabb175f2012-09-24 12:43:26 +02001045 All parameters supported by "bind" lines are supported, for instance to
1046 restrict access to some users or their access rights. Please consult
1047 section 5.1 for more information.
Willy Tarreaufbee7132007-10-18 13:53:22 +02001048
1049stats timeout <timeout, in milliseconds>
1050 The default timeout on the stats socket is set to 10 seconds. It is possible
1051 to change this value with "stats timeout". The value must be passed in
Willy Tarreaubefdff12007-12-02 22:27:38 +01001052 milliseconds, or be suffixed by a time unit among { us, ms, s, m, h, d }.
Willy Tarreaufbee7132007-10-18 13:53:22 +02001053
1054stats maxconn <connections>
1055 By default, the stats socket is limited to 10 concurrent connections. It is
1056 possible to change this value with "stats maxconn".
1057
Willy Tarreau6a06a402007-07-15 20:15:28 +02001058uid <number>
1059 Changes the process' user ID to <number>. It is recommended that the user ID
1060 is dedicated to HAProxy or to a small set of similar daemons. HAProxy must
1061 be started with superuser privileges in order to be able to switch to another
1062 one. See also "gid" and "user".
1063
1064ulimit-n <number>
1065 Sets the maximum number of per-process file-descriptors to <number>. By
1066 default, it is automatically computed, so it is recommended not to use this
1067 option.
1068
Willy Tarreauceb24bc2010-11-09 12:46:41 +01001069unix-bind [ prefix <prefix> ] [ mode <mode> ] [ user <user> ] [ uid <uid> ]
1070 [ group <group> ] [ gid <gid> ]
1071
1072 Fixes common settings to UNIX listening sockets declared in "bind" statements.
1073 This is mainly used to simplify declaration of those UNIX sockets and reduce
1074 the risk of errors, since those settings are most commonly required but are
1075 also process-specific. The <prefix> setting can be used to force all socket
1076 path to be relative to that directory. This might be needed to access another
1077 component's chroot. Note that those paths are resolved before haproxy chroots
1078 itself, so they are absolute. The <mode>, <user>, <uid>, <group> and <gid>
1079 all have the same meaning as their homonyms used by the "bind" statement. If
1080 both are specified, the "bind" statement has priority, meaning that the
1081 "unix-bind" settings may be seen as process-wide default settings.
1082
Willy Tarreau1d549722016-02-16 12:41:57 +01001083unsetenv [<name> ...]
1084 Removes environment variables specified in arguments. This can be useful to
1085 hide some sensitive information that are occasionally inherited from the
1086 user's environment during some operations. Variables which did not exist are
1087 silently ignored so that after the operation, it is certain that none of
1088 these variables remain. The changes immediately take effect so that the next
1089 line in the configuration file will not see these variables. See also
1090 "setenv", "presetenv", and "resetenv".
1091
Willy Tarreau6a06a402007-07-15 20:15:28 +02001092user <user name>
1093 Similar to "uid" but uses the UID of user name <user name> from /etc/passwd.
1094 See also "uid" and "group".
1095
Krzysztof Piotr Oledzki48cb2ae2009-10-02 22:51:14 +02001096node <name>
1097 Only letters, digits, hyphen and underscore are allowed, like in DNS names.
1098
1099 This statement is useful in HA configurations where two or more processes or
1100 servers share the same IP address. By setting a different node-name on all
1101 nodes, it becomes easy to immediately spot what server is handling the
1102 traffic.
1103
1104description <text>
1105 Add a text that describes the instance.
1106
1107 Please note that it is required to escape certain characters (# for example)
1108 and this text is inserted into a html page so you should avoid using
1109 "<" and ">" characters.
1110
Thomas Holmesdb04f192015-05-18 13:21:39 +0100111151degrees-data-file <file path>
1112 The path of the 51Degrees data file to provide device detection services. The
Davor Ocelice9ed2812017-12-25 17:49:28 +01001113 file should be unzipped and accessible by HAProxy with relevant permissions.
Thomas Holmesdb04f192015-05-18 13:21:39 +01001114
Dragan Dosenae6d39a2015-06-29 16:43:27 +02001115 Please note that this option is only available when haproxy has been
Thomas Holmesdb04f192015-05-18 13:21:39 +01001116 compiled with USE_51DEGREES.
1117
Ben Shillitof25e8e52016-12-02 14:25:37 +0000111851degrees-property-name-list [<string> ...]
Thomas Holmesdb04f192015-05-18 13:21:39 +01001119 A list of 51Degrees property names to be load from the dataset. A full list
1120 of names is available on the 51Degrees website:
1121 https://51degrees.com/resources/property-dictionary
1122
Dragan Dosenae6d39a2015-06-29 16:43:27 +02001123 Please note that this option is only available when haproxy has been
Thomas Holmesdb04f192015-05-18 13:21:39 +01001124 compiled with USE_51DEGREES.
1125
Dragan Dosen93b38d92015-06-29 16:43:25 +0200112651degrees-property-separator <char>
Thomas Holmesdb04f192015-05-18 13:21:39 +01001127 A char that will be appended to every property value in a response header
1128 containing 51Degrees results. If not set that will be set as ','.
1129
Dragan Dosenae6d39a2015-06-29 16:43:27 +02001130 Please note that this option is only available when haproxy has been
1131 compiled with USE_51DEGREES.
1132
113351degrees-cache-size <number>
1134 Sets the size of the 51Degrees converter cache to <number> entries. This
1135 is an LRU cache which reminds previous device detections and their results.
1136 By default, this cache is disabled.
1137
1138 Please note that this option is only available when haproxy has been
Thomas Holmesdb04f192015-05-18 13:21:39 +01001139 compiled with USE_51DEGREES.
1140
scientiamobiled0027ed2016-11-04 10:55:08 +01001141wurfl-data-file <file path>
1142 The path of the WURFL data file to provide device detection services. The
1143 file should be accessible by HAProxy with relevant permissions.
1144
1145 Please note that this option is only available when haproxy has been compiled
1146 with USE_WURFL=1.
1147
1148wurfl-information-list [<capability>]*
1149 A space-delimited list of WURFL capabilities, virtual capabilities, property
1150 names we plan to use in injected headers. A full list of capability and
1151 virtual capability names is available on the Scientiamobile website :
1152
1153 https://www.scientiamobile.com/wurflCapability
1154
1155 Valid WURFL properties are:
1156 - wurfl_id Contains the device ID of the matched device.
1157
1158 - wurfl_root_id Contains the device root ID of the matched
1159 device.
1160
1161 - wurfl_isdevroot Tells if the matched device is a root device.
1162 Possible values are "TRUE" or "FALSE".
1163
1164 - wurfl_useragent The original useragent coming with this
1165 particular web request.
1166
1167 - wurfl_api_version Contains a string representing the currently
1168 used Libwurfl API version.
1169
1170 - wurfl_engine_target Contains a string representing the currently
1171 set WURFL Engine Target. Possible values are
1172 "HIGH_ACCURACY", "HIGH_PERFORMANCE", "INVALID".
1173
1174 - wurfl_info A string containing information on the parsed
1175 wurfl.xml and its full path.
1176
1177 - wurfl_last_load_time Contains the UNIX timestamp of the last time
1178 WURFL has been loaded successfully.
1179
1180 - wurfl_normalized_useragent The normalized useragent.
1181
1182 - wurfl_useragent_priority The user agent priority used by WURFL.
1183
1184 Please note that this option is only available when haproxy has been compiled
1185 with USE_WURFL=1.
1186
1187wurfl-information-list-separator <char>
1188 A char that will be used to separate values in a response header containing
1189 WURFL results. If not set that a comma (',') will be used by default.
1190
1191 Please note that this option is only available when haproxy has been compiled
1192 with USE_WURFL=1.
1193
1194wurfl-patch-file [<file path>]
1195 A list of WURFL patch file paths. Note that patches are loaded during startup
1196 thus before the chroot.
1197
1198 Please note that this option is only available when haproxy has been compiled
1199 with USE_WURFL=1.
1200
1201wurfl-engine-mode { accuracy | performance }
1202 Sets the WURFL engine target. You can choose between 'accuracy' or
1203 'performance' targets. In performance mode, desktop web browser detection is
Davor Ocelice9ed2812017-12-25 17:49:28 +01001204 done programmatically without referencing the WURFL data. As a result, most
scientiamobiled0027ed2016-11-04 10:55:08 +01001205 desktop web browsers are returned as generic_web_browser WURFL ID for
Davor Ocelice9ed2812017-12-25 17:49:28 +01001206 performance. If either performance or accuracy are not defined, performance
scientiamobiled0027ed2016-11-04 10:55:08 +01001207 mode is enabled by default.
1208
1209 Please note that this option is only available when haproxy has been compiled
1210 with USE_WURFL=1.
1211
1212wurfl-cache-size <U>[,<D>]
1213 Sets the WURFL caching strategy. Here <U> is the Useragent cache size, and
1214 <D> is the internal device cache size. There are three possibilities here :
1215 - "0" : no cache is used.
1216 - <U> : the Single LRU cache is used, the size is expressed in elements.
1217 - <U>,<D> : the Double LRU cache is used, both sizes are in elements. This is
1218 the highest performing option.
1219
1220 Please note that this option is only available when haproxy has been compiled
1221 with USE_WURFL=1.
1222
1223wurfl-useragent-priority { plain | sideloaded_browser }
1224 Tells WURFL if it should prioritize use of the plain user agent ('plain')
1225 over the default sideloaded browser user agent ('sideloaded_browser').
1226
1227 Please note that this option is only available when haproxy has been compiled
1228 with USE_WURFL=1.
1229
Willy Tarreau6a06a402007-07-15 20:15:28 +02001230
Willy Tarreauc57f0e22009-05-10 13:12:33 +020012313.2. Performance tuning
Willy Tarreau6a06a402007-07-15 20:15:28 +02001232-----------------------
1233
Willy Tarreau1746eec2014-04-25 10:46:47 +02001234max-spread-checks <delay in milliseconds>
1235 By default, haproxy tries to spread the start of health checks across the
1236 smallest health check interval of all the servers in a farm. The principle is
1237 to avoid hammering services running on the same server. But when using large
1238 check intervals (10 seconds or more), the last servers in the farm take some
1239 time before starting to be tested, which can be a problem. This parameter is
1240 used to enforce an upper bound on delay between the first and the last check,
1241 even if the servers' check intervals are larger. When servers run with
1242 shorter intervals, their intervals will be respected though.
1243
Willy Tarreau6a06a402007-07-15 20:15:28 +02001244maxconn <number>
1245 Sets the maximum per-process number of concurrent connections to <number>. It
1246 is equivalent to the command-line argument "-n". Proxies will stop accepting
1247 connections when this limit is reached. The "ulimit-n" parameter is
Willy Tarreau8274e102014-06-19 15:31:25 +02001248 automatically adjusted according to this value. See also "ulimit-n". Note:
1249 the "select" poller cannot reliably use more than 1024 file descriptors on
1250 some platforms. If your platform only supports select and reports "select
1251 FAILED" on startup, you need to reduce maxconn until it works (slightly
Willy Tarreaud0256482015-01-15 21:45:22 +01001252 below 500 in general). If this value is not set, it will default to the value
1253 set in DEFAULT_MAXCONN at build time (reported in haproxy -vv) if no memory
1254 limit is enforced, or will be computed based on the memory limit, the buffer
1255 size, memory allocated to compression, SSL cache size, and use or not of SSL
1256 and the associated maxsslconn (which can also be automatic).
Willy Tarreau6a06a402007-07-15 20:15:28 +02001257
Willy Tarreau81c25d02011-09-07 15:17:21 +02001258maxconnrate <number>
1259 Sets the maximum per-process number of connections per second to <number>.
1260 Proxies will stop accepting connections when this limit is reached. It can be
1261 used to limit the global capacity regardless of each frontend capacity. It is
1262 important to note that this can only be used as a service protection measure,
1263 as there will not necessarily be a fair share between frontends when the
1264 limit is reached, so it's a good idea to also limit each frontend to some
1265 value close to its expected share. Also, lowering tune.maxaccept can improve
1266 fairness.
1267
William Lallemandd85f9172012-11-09 17:05:39 +01001268maxcomprate <number>
1269 Sets the maximum per-process input compression rate to <number> kilobytes
Davor Ocelice9ed2812017-12-25 17:49:28 +01001270 per second. For each session, if the maximum is reached, the compression
William Lallemandd85f9172012-11-09 17:05:39 +01001271 level will be decreased during the session. If the maximum is reached at the
1272 beginning of a session, the session will not compress at all. If the maximum
1273 is not reached, the compression level will be increased up to
Davor Ocelice9ed2812017-12-25 17:49:28 +01001274 tune.comp.maxlevel. A value of zero means there is no limit, this is the
William Lallemandd85f9172012-11-09 17:05:39 +01001275 default value.
1276
William Lallemand072a2bf2012-11-20 17:01:01 +01001277maxcompcpuusage <number>
1278 Sets the maximum CPU usage HAProxy can reach before stopping the compression
1279 for new requests or decreasing the compression level of current requests.
1280 It works like 'maxcomprate' but measures CPU usage instead of incoming data
1281 bandwidth. The value is expressed in percent of the CPU used by haproxy. In
1282 case of multiple processes (nbproc > 1), each process manages its individual
1283 usage. A value of 100 disable the limit. The default value is 100. Setting
1284 a lower value will prevent the compression work from slowing the whole
1285 process down and from introducing high latencies.
1286
Willy Tarreauff4f82d2009-02-06 11:28:13 +01001287maxpipes <number>
1288 Sets the maximum per-process number of pipes to <number>. Currently, pipes
1289 are only used by kernel-based tcp splicing. Since a pipe contains two file
1290 descriptors, the "ulimit-n" value will be increased accordingly. The default
1291 value is maxconn/4, which seems to be more than enough for most heavy usages.
1292 The splice code dynamically allocates and releases pipes, and can fall back
1293 to standard copy, so setting this value too low may only impact performance.
1294
Willy Tarreau93e7c002013-10-07 18:51:07 +02001295maxsessrate <number>
1296 Sets the maximum per-process number of sessions per second to <number>.
1297 Proxies will stop accepting connections when this limit is reached. It can be
1298 used to limit the global capacity regardless of each frontend capacity. It is
1299 important to note that this can only be used as a service protection measure,
1300 as there will not necessarily be a fair share between frontends when the
1301 limit is reached, so it's a good idea to also limit each frontend to some
1302 value close to its expected share. Also, lowering tune.maxaccept can improve
1303 fairness.
1304
Willy Tarreau403edff2012-09-06 11:58:37 +02001305maxsslconn <number>
1306 Sets the maximum per-process number of concurrent SSL connections to
1307 <number>. By default there is no SSL-specific limit, which means that the
1308 global maxconn setting will apply to all connections. Setting this limit
1309 avoids having openssl use too much memory and crash when malloc returns NULL
1310 (since it unfortunately does not reliably check for such conditions). Note
1311 that the limit applies both to incoming and outgoing connections, so one
1312 connection which is deciphered then ciphered accounts for 2 SSL connections.
Willy Tarreaud0256482015-01-15 21:45:22 +01001313 If this value is not set, but a memory limit is enforced, this value will be
1314 automatically computed based on the memory limit, maxconn, the buffer size,
1315 memory allocated to compression, SSL cache size, and use of SSL in either
1316 frontends, backends or both. If neither maxconn nor maxsslconn are specified
1317 when there is a memory limit, haproxy will automatically adjust these values
1318 so that 100% of the connections can be made over SSL with no risk, and will
1319 consider the sides where it is enabled (frontend, backend, both).
Willy Tarreau403edff2012-09-06 11:58:37 +02001320
Willy Tarreaue43d5322013-10-07 20:01:52 +02001321maxsslrate <number>
1322 Sets the maximum per-process number of SSL sessions per second to <number>.
1323 SSL listeners will stop accepting connections when this limit is reached. It
1324 can be used to limit the global SSL CPU usage regardless of each frontend
1325 capacity. It is important to note that this can only be used as a service
1326 protection measure, as there will not necessarily be a fair share between
1327 frontends when the limit is reached, so it's a good idea to also limit each
1328 frontend to some value close to its expected share. It is also important to
1329 note that the sessions are accounted before they enter the SSL stack and not
1330 after, which also protects the stack against bad handshakes. Also, lowering
1331 tune.maxaccept can improve fairness.
1332
William Lallemand9d5f5482012-11-07 16:12:57 +01001333maxzlibmem <number>
1334 Sets the maximum amount of RAM in megabytes per process usable by the zlib.
1335 When the maximum amount is reached, future sessions will not compress as long
1336 as RAM is unavailable. When sets to 0, there is no limit.
William Lallemande3a7d992012-11-20 11:25:20 +01001337 The default value is 0. The value is available in bytes on the UNIX socket
1338 with "show info" on the line "MaxZlibMemUsage", the memory used by zlib is
1339 "ZlibMemUsage" in bytes.
1340
Willy Tarreau6a06a402007-07-15 20:15:28 +02001341noepoll
1342 Disables the use of the "epoll" event polling system on Linux. It is
1343 equivalent to the command-line argument "-de". The next polling system
Willy Tarreaue9f49e72012-11-11 17:42:00 +01001344 used will generally be "poll". See also "nopoll".
Willy Tarreau6a06a402007-07-15 20:15:28 +02001345
1346nokqueue
1347 Disables the use of the "kqueue" event polling system on BSD. It is
1348 equivalent to the command-line argument "-dk". The next polling system
1349 used will generally be "poll". See also "nopoll".
1350
1351nopoll
1352 Disables the use of the "poll" event polling system. It is equivalent to the
1353 command-line argument "-dp". The next polling system used will be "select".
Willy Tarreau0ba27502007-12-24 16:55:16 +01001354 It should never be needed to disable "poll" since it's available on all
Willy Tarreaue9f49e72012-11-11 17:42:00 +01001355 platforms supported by HAProxy. See also "nokqueue" and "noepoll".
Willy Tarreau6a06a402007-07-15 20:15:28 +02001356
Willy Tarreauff4f82d2009-02-06 11:28:13 +01001357nosplice
1358 Disables the use of kernel tcp splicing between sockets on Linux. It is
Davor Ocelice9ed2812017-12-25 17:49:28 +01001359 equivalent to the command line argument "-dS". Data will then be copied
Willy Tarreauff4f82d2009-02-06 11:28:13 +01001360 using conventional and more portable recv/send calls. Kernel tcp splicing is
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +01001361 limited to some very recent instances of kernel 2.6. Most versions between
Willy Tarreauff4f82d2009-02-06 11:28:13 +01001362 2.6.25 and 2.6.28 are buggy and will forward corrupted data, so they must not
1363 be used. This option makes it easier to globally disable kernel splicing in
1364 case of doubt. See also "option splice-auto", "option splice-request" and
1365 "option splice-response".
1366
Jarno Huuskonen0e82b922014-04-12 18:22:19 +03001367nogetaddrinfo
1368 Disables the use of getaddrinfo(3) for name resolving. It is equivalent to
1369 the command line argument "-dG". Deprecated gethostbyname(3) will be used.
1370
Lukas Tribusa0bcbdc2016-09-12 21:42:20 +00001371noreuseport
1372 Disables the use of SO_REUSEPORT - see socket(7). It is equivalent to the
1373 command line argument "-dR".
1374
Willy Tarreaufe255b72007-10-14 23:09:26 +02001375spread-checks <0..50, in percent>
Simon Hormand60d6912013-11-25 10:46:36 +09001376 Sometimes it is desirable to avoid sending agent and health checks to
1377 servers at exact intervals, for instance when many logical servers are
1378 located on the same physical server. With the help of this parameter, it
1379 becomes possible to add some randomness in the check interval between 0
1380 and +/- 50%. A value between 2 and 5 seems to show good results. The
1381 default value remains at 0.
Willy Tarreaufe255b72007-10-14 23:09:26 +02001382
Davor Ocelice9ed2812017-12-25 17:49:28 +01001383ssl-engine <name> [algo <comma-separated list of algorithms>]
Grant Zhang872f9c22017-01-21 01:10:18 +00001384 Sets the OpenSSL engine to <name>. List of valid values for <name> may be
Davor Ocelice9ed2812017-12-25 17:49:28 +01001385 obtained using the command "openssl engine". This statement may be used
Grant Zhang872f9c22017-01-21 01:10:18 +00001386 multiple times, it will simply enable multiple crypto engines. Referencing an
1387 unsupported engine will prevent haproxy from starting. Note that many engines
1388 will lead to lower HTTPS performance than pure software with recent
1389 processors. The optional command "algo" sets the default algorithms an ENGINE
1390 will supply using the OPENSSL function ENGINE_set_default_string(). A value
Davor Ocelice9ed2812017-12-25 17:49:28 +01001391 of "ALL" uses the engine for all cryptographic operations. If no list of
1392 algo is specified then the value of "ALL" is used. A comma-separated list
Grant Zhang872f9c22017-01-21 01:10:18 +00001393 of different algorithms may be specified, including: RSA, DSA, DH, EC, RAND,
1394 CIPHERS, DIGESTS, PKEY, PKEY_CRYPTO, PKEY_ASN1. This is the same format that
1395 openssl configuration file uses:
1396 https://www.openssl.org/docs/man1.0.2/apps/config.html
1397
Grant Zhangfa6c7ee2017-01-14 01:42:15 +00001398ssl-mode-async
1399 Adds SSL_MODE_ASYNC mode to the SSL context. This enables asynchronous TLS
Emeric Brun3854e012017-05-17 20:42:48 +02001400 I/O operations if asynchronous capable SSL engines are used. The current
Emeric Brunb5e42a82017-06-06 12:35:14 +00001401 implementation supports a maximum of 32 engines. The Openssl ASYNC API
1402 doesn't support moving read/write buffers and is not compliant with
1403 haproxy's buffer management. So the asynchronous mode is disabled on
1404 read/write operations (it is only enabled during initial and reneg
1405 handshakes).
Grant Zhangfa6c7ee2017-01-14 01:42:15 +00001406
Willy Tarreau33cb0652014-12-23 22:52:37 +01001407tune.buffers.limit <number>
1408 Sets a hard limit on the number of buffers which may be allocated per process.
1409 The default value is zero which means unlimited. The minimum non-zero value
1410 will always be greater than "tune.buffers.reserve" and should ideally always
1411 be about twice as large. Forcing this value can be particularly useful to
1412 limit the amount of memory a process may take, while retaining a sane
Davor Ocelice9ed2812017-12-25 17:49:28 +01001413 behavior. When this limit is reached, sessions which need a buffer wait for
Willy Tarreau33cb0652014-12-23 22:52:37 +01001414 another one to be released by another session. Since buffers are dynamically
1415 allocated and released, the waiting time is very short and not perceptible
1416 provided that limits remain reasonable. In fact sometimes reducing the limit
1417 may even increase performance by increasing the CPU cache's efficiency. Tests
1418 have shown good results on average HTTP traffic with a limit to 1/10 of the
1419 expected global maxconn setting, which also significantly reduces memory
1420 usage. The memory savings come from the fact that a number of connections
1421 will not allocate 2*tune.bufsize. It is best not to touch this value unless
1422 advised to do so by an haproxy core developer.
1423
Willy Tarreau1058ae72014-12-23 22:40:40 +01001424tune.buffers.reserve <number>
1425 Sets the number of buffers which are pre-allocated and reserved for use only
1426 during memory shortage conditions resulting in failed memory allocations. The
1427 minimum value is 2 and is also the default. There is no reason a user would
1428 want to change this value, it's mostly aimed at haproxy core developers.
1429
Willy Tarreau27a674e2009-08-17 07:23:33 +02001430tune.bufsize <number>
1431 Sets the buffer size to this size (in bytes). Lower values allow more
1432 sessions to coexist in the same amount of RAM, and higher values allow some
1433 applications with very large cookies to work. The default value is 16384 and
1434 can be changed at build time. It is strongly recommended not to change this
1435 from the default value, as very low values will break some services such as
1436 statistics, and values larger than default size will increase memory usage,
1437 possibly causing the system to run out of memory. At least the global maxconn
Willy Tarreau45a66cc2017-11-24 11:28:00 +01001438 parameter should be decreased by the same factor as this one is increased. In
1439 addition, use of HTTP/2 mandates that this value must be 16384 or more. If an
1440 HTTP request is larger than (tune.bufsize - tune.maxrewrite), haproxy will
Dmitry Sivachenkof6f4f7b2012-10-21 18:10:25 +04001441 return HTTP 400 (Bad Request) error. Similarly if an HTTP response is larger
1442 than this size, haproxy will return HTTP 502 (Bad Gateway).
Willy Tarreau27a674e2009-08-17 07:23:33 +02001443
Willy Tarreau43961d52010-10-04 20:39:20 +02001444tune.chksize <number>
1445 Sets the check buffer size to this size (in bytes). Higher values may help
1446 find string or regex patterns in very large pages, though doing so may imply
1447 more memory and CPU usage. The default value is 16384 and can be changed at
1448 build time. It is not recommended to change this value, but to use better
1449 checks whenever possible.
1450
William Lallemandf3747832012-11-09 12:33:10 +01001451tune.comp.maxlevel <number>
1452 Sets the maximum compression level. The compression level affects CPU
1453 usage during compression. This value affects CPU usage during compression.
1454 Each session using compression initializes the compression algorithm with
1455 this value. The default value is 1.
1456
Willy Tarreaufe20e5b2017-07-27 11:42:14 +02001457tune.h2.header-table-size <number>
1458 Sets the HTTP/2 dynamic header table size. It defaults to 4096 bytes and
1459 cannot be larger than 65536 bytes. A larger value may help certain clients
1460 send more compact requests, depending on their capabilities. This amount of
1461 memory is consumed for each HTTP/2 connection. It is recommended not to
1462 change it.
1463
Willy Tarreaue6baec02017-07-27 11:45:11 +02001464tune.h2.initial-window-size <number>
1465 Sets the HTTP/2 initial window size, which is the number of bytes the client
Davor Ocelice9ed2812017-12-25 17:49:28 +01001466 can upload before waiting for an acknowledgment from haproxy. This setting
1467 only affects payload contents (i.e. the body of POST requests), not headers.
Willy Tarreaue6baec02017-07-27 11:45:11 +02001468 The default value is 65535, which roughly allows up to 5 Mbps of upload
1469 bandwidth per client over a network showing a 100 ms ping time, or 500 Mbps
1470 over a 1-ms local network. It can make sense to increase this value to allow
1471 faster uploads, or to reduce it to increase fairness when dealing with many
1472 clients. It doesn't affect resource usage.
1473
Willy Tarreau5242ef82017-07-27 11:47:28 +02001474tune.h2.max-concurrent-streams <number>
1475 Sets the HTTP/2 maximum number of concurrent streams per connection (ie the
1476 number of outstanding requests on a single connection). The default value is
1477 100. A larger one may slightly improve page load time for complex sites when
1478 visited over high latency networks, but increases the amount of resources a
1479 single client may allocate. A value of zero disables the limit so a single
1480 client may create as many streams as allocatable by haproxy. It is highly
1481 recommended not to change this value.
1482
Willy Tarreau193b8c62012-11-22 00:17:38 +01001483tune.http.cookielen <number>
1484 Sets the maximum length of captured cookies. This is the maximum value that
1485 the "capture cookie xxx len yyy" will be allowed to take, and any upper value
1486 will automatically be truncated to this one. It is important not to set too
1487 high a value because all cookie captures still allocate this size whatever
1488 their configured value (they share a same pool). This value is per request
1489 per response, so the memory allocated is twice this value per connection.
1490 When not specified, the limit is set to 63 characters. It is recommended not
1491 to change this value.
1492
Stéphane Cottin23e9e932017-05-18 08:58:41 +02001493tune.http.logurilen <number>
Davor Ocelice9ed2812017-12-25 17:49:28 +01001494 Sets the maximum length of request URI in logs. This prevents truncating long
1495 request URIs with valuable query strings in log lines. This is not related
Stéphane Cottin23e9e932017-05-18 08:58:41 +02001496 to syslog limits. If you increase this limit, you may also increase the
Davor Ocelice9ed2812017-12-25 17:49:28 +01001497 'log ... len yyy' parameter. Your syslog daemon may also need specific
Stéphane Cottin23e9e932017-05-18 08:58:41 +02001498 configuration directives too.
1499 The default value is 1024.
1500
Willy Tarreauac1932d2011-10-24 19:14:41 +02001501tune.http.maxhdr <number>
1502 Sets the maximum number of headers in a request. When a request comes with a
1503 number of headers greater than this value (including the first line), it is
1504 rejected with a "400 Bad Request" status code. Similarly, too large responses
1505 are blocked with "502 Bad Gateway". The default value is 101, which is enough
1506 for all usages, considering that the widely deployed Apache server uses the
1507 same limit. It can be useful to push this limit further to temporarily allow
Christopher Faulet50174f32017-06-21 16:31:35 +02001508 a buggy application to work by the time it gets fixed. The accepted range is
1509 1..32767. Keep in mind that each new header consumes 32bits of memory for
1510 each session, so don't push this limit too high.
Willy Tarreauac1932d2011-10-24 19:14:41 +02001511
Willy Tarreau7e312732014-02-12 16:35:14 +01001512tune.idletimer <timeout>
1513 Sets the duration after which haproxy will consider that an empty buffer is
1514 probably associated with an idle stream. This is used to optimally adjust
1515 some packet sizes while forwarding large and small data alternatively. The
1516 decision to use splice() or to send large buffers in SSL is modulated by this
1517 parameter. The value is in milliseconds between 0 and 65535. A value of zero
1518 means that haproxy will not try to detect idle streams. The default is 1000,
Davor Ocelice9ed2812017-12-25 17:49:28 +01001519 which seems to correctly detect end user pauses (e.g. read a page before
Willy Tarreau7e312732014-02-12 16:35:14 +01001520 clicking). There should be not reason for changing this value. Please check
1521 tune.ssl.maxrecord below.
1522
Thierry FOURNIER90da1912015-03-05 11:17:06 +01001523tune.lua.forced-yield <number>
1524 This directive forces the Lua engine to execute a yield each <number> of
Tim Düsterhus4896c442016-11-29 02:15:19 +01001525 instructions executed. This permits interrupting a long script and allows the
Thierry FOURNIER90da1912015-03-05 11:17:06 +01001526 HAProxy scheduler to process other tasks like accepting connections or
1527 forwarding traffic. The default value is 10000 instructions. If HAProxy often
Davor Ocelice9ed2812017-12-25 17:49:28 +01001528 executes some Lua code but more responsiveness is required, this value can be
Thierry FOURNIER90da1912015-03-05 11:17:06 +01001529 lowered. If the Lua code is quite long and its result is absolutely required
1530 to process the data, the <number> can be increased.
1531
Willy Tarreau32f61e22015-03-18 17:54:59 +01001532tune.lua.maxmem
1533 Sets the maximum amount of RAM in megabytes per process usable by Lua. By
1534 default it is zero which means unlimited. It is important to set a limit to
1535 ensure that a bug in a script will not result in the system running out of
1536 memory.
1537
Thierry FOURNIER90da1912015-03-05 11:17:06 +01001538tune.lua.session-timeout <timeout>
1539 This is the execution timeout for the Lua sessions. This is useful for
Thierry FOURNIER7dd784b2015-10-01 14:49:33 +02001540 preventing infinite loops or spending too much time in Lua. This timeout
1541 counts only the pure Lua runtime. If the Lua does a sleep, the sleep is
Davor Ocelice9ed2812017-12-25 17:49:28 +01001542 not taken in account. The default timeout is 4s.
Thierry FOURNIER90da1912015-03-05 11:17:06 +01001543
1544tune.lua.task-timeout <timeout>
1545 Purpose is the same as "tune.lua.session-timeout", but this timeout is
1546 dedicated to the tasks. By default, this timeout isn't set because a task may
1547 remain alive during of the lifetime of HAProxy. For example, a task used to
1548 check servers.
1549
Thierry FOURNIER7dd784b2015-10-01 14:49:33 +02001550tune.lua.service-timeout <timeout>
1551 This is the execution timeout for the Lua services. This is useful for
1552 preventing infinite loops or spending too much time in Lua. This timeout
1553 counts only the pure Lua runtime. If the Lua does a sleep, the sleep is
Davor Ocelice9ed2812017-12-25 17:49:28 +01001554 not taken in account. The default timeout is 4s.
Thierry FOURNIER7dd784b2015-10-01 14:49:33 +02001555
Willy Tarreaua0250ba2008-01-06 11:22:57 +01001556tune.maxaccept <number>
Willy Tarreau16a21472012-11-19 12:39:59 +01001557 Sets the maximum number of consecutive connections a process may accept in a
1558 row before switching to other work. In single process mode, higher numbers
1559 give better performance at high connection rates. However in multi-process
1560 modes, keeping a bit of fairness between processes generally is better to
1561 increase performance. This value applies individually to each listener, so
1562 that the number of processes a listener is bound to is taken into account.
1563 This value defaults to 64. In multi-process mode, it is divided by twice
1564 the number of processes the listener is bound to. Setting this value to -1
1565 completely disables the limitation. It should normally not be needed to tweak
1566 this value.
Willy Tarreaua0250ba2008-01-06 11:22:57 +01001567
1568tune.maxpollevents <number>
1569 Sets the maximum amount of events that can be processed at once in a call to
1570 the polling system. The default value is adapted to the operating system. It
1571 has been noticed that reducing it below 200 tends to slightly decrease
1572 latency at the expense of network bandwidth, and increasing it above 200
1573 tends to trade latency for slightly increased bandwidth.
1574
Willy Tarreau27a674e2009-08-17 07:23:33 +02001575tune.maxrewrite <number>
1576 Sets the reserved buffer space to this size in bytes. The reserved space is
1577 used for header rewriting or appending. The first reads on sockets will never
1578 fill more than bufsize-maxrewrite. Historically it has defaulted to half of
1579 bufsize, though that does not make much sense since there are rarely large
1580 numbers of headers to add. Setting it too high prevents processing of large
1581 requests or responses. Setting it too low prevents addition of new headers
1582 to already large requests or to POST requests. It is generally wise to set it
1583 to about 1024. It is automatically readjusted to half of bufsize if it is
1584 larger than that. This means you don't have to worry about it when changing
1585 bufsize.
1586
Willy Tarreauf3045d22015-04-29 16:24:50 +02001587tune.pattern.cache-size <number>
1588 Sets the size of the pattern lookup cache to <number> entries. This is an LRU
1589 cache which reminds previous lookups and their results. It is used by ACLs
1590 and maps on slow pattern lookups, namely the ones using the "sub", "reg",
1591 "dir", "dom", "end", "bin" match methods as well as the case-insensitive
1592 strings. It applies to pattern expressions which means that it will be able
1593 to memorize the result of a lookup among all the patterns specified on a
1594 configuration line (including all those loaded from files). It automatically
1595 invalidates entries which are updated using HTTP actions or on the CLI. The
1596 default cache size is set to 10000 entries, which limits its footprint to
1597 about 5 MB on 32-bit systems and 8 MB on 64-bit systems. There is a very low
1598 risk of collision in this cache, which is in the order of the size of the
1599 cache divided by 2^64. Typically, at 10000 requests per second with the
1600 default cache size of 10000 entries, there's 1% chance that a brute force
1601 attack could cause a single collision after 60 years, or 0.1% after 6 years.
1602 This is considered much lower than the risk of a memory corruption caused by
1603 aging components. If this is not acceptable, the cache can be disabled by
1604 setting this parameter to 0.
1605
Willy Tarreaubd9a0a72011-10-23 21:14:29 +02001606tune.pipesize <number>
1607 Sets the kernel pipe buffer size to this size (in bytes). By default, pipes
1608 are the default size for the system. But sometimes when using TCP splicing,
1609 it can improve performance to increase pipe sizes, especially if it is
1610 suspected that pipes are not filled and that many calls to splice() are
1611 performed. This has an impact on the kernel's memory footprint, so this must
1612 not be changed if impacts are not understood.
1613
Willy Tarreaue803de22010-01-21 17:43:04 +01001614tune.rcvbuf.client <number>
1615tune.rcvbuf.server <number>
1616 Forces the kernel socket receive buffer size on the client or the server side
1617 to the specified value in bytes. This value applies to all TCP/HTTP frontends
1618 and backends. It should normally never be set, and the default size (0) lets
1619 the kernel autotune this value depending on the amount of available memory.
Davor Ocelice9ed2812017-12-25 17:49:28 +01001620 However it can sometimes help to set it to very low values (e.g. 4096) in
Willy Tarreaue803de22010-01-21 17:43:04 +01001621 order to save kernel memory by preventing it from buffering too large amounts
1622 of received data. Lower values will significantly increase CPU usage though.
1623
Willy Tarreaub22fc302015-12-14 12:04:35 +01001624tune.recv_enough <number>
Davor Ocelice9ed2812017-12-25 17:49:28 +01001625 HAProxy uses some hints to detect that a short read indicates the end of the
Willy Tarreaub22fc302015-12-14 12:04:35 +01001626 socket buffers. One of them is that a read returns more than <recv_enough>
1627 bytes, which defaults to 10136 (7 segments of 1448 each). This default value
1628 may be changed by this setting to better deal with workloads involving lots
1629 of short messages such as telnet or SSH sessions.
1630
Olivier Houchard1599b802018-05-24 18:59:04 +02001631tune.runqueue-depth <number>
1632 Sets the maxinum amount of task that can be processed at once when running
1633 tasks. The default value is 200. Increasing it may incur latency when
1634 dealing with I/Os, making it too small can incur extra overhead.
1635
Willy Tarreaue803de22010-01-21 17:43:04 +01001636tune.sndbuf.client <number>
1637tune.sndbuf.server <number>
1638 Forces the kernel socket send buffer size on the client or the server side to
1639 the specified value in bytes. This value applies to all TCP/HTTP frontends
1640 and backends. It should normally never be set, and the default size (0) lets
1641 the kernel autotune this value depending on the amount of available memory.
Davor Ocelice9ed2812017-12-25 17:49:28 +01001642 However it can sometimes help to set it to very low values (e.g. 4096) in
Willy Tarreaue803de22010-01-21 17:43:04 +01001643 order to save kernel memory by preventing it from buffering too large amounts
1644 of received data. Lower values will significantly increase CPU usage though.
1645 Another use case is to prevent write timeouts with extremely slow clients due
1646 to the kernel waiting for a large part of the buffer to be read before
1647 notifying haproxy again.
1648
Willy Tarreau6ec58db2012-11-16 16:32:15 +01001649tune.ssl.cachesize <number>
Emeric Brunaf9619d2012-11-28 18:47:52 +01001650 Sets the size of the global SSL session cache, in a number of blocks. A block
1651 is large enough to contain an encoded session without peer certificate.
1652 An encoded session with peer certificate is stored in multiple blocks
Jarno Huuskonen0e82b922014-04-12 18:22:19 +03001653 depending on the size of the peer certificate. A block uses approximately
Emeric Brunaf9619d2012-11-28 18:47:52 +01001654 200 bytes of memory. The default value may be forced at build time, otherwise
Davor Ocelice9ed2812017-12-25 17:49:28 +01001655 defaults to 20000. When the cache is full, the most idle entries are purged
Emeric Brunaf9619d2012-11-28 18:47:52 +01001656 and reassigned. Higher values reduce the occurrence of such a purge, hence
1657 the number of CPU-intensive SSL handshakes by ensuring that all users keep
1658 their session as long as possible. All entries are pre-allocated upon startup
Emeric Brun22890a12012-12-28 14:41:32 +01001659 and are shared between all processes if "nbproc" is greater than 1. Setting
1660 this value to 0 disables the SSL session cache.
Willy Tarreau6ec58db2012-11-16 16:32:15 +01001661
Emeric Brun8dc60392014-05-09 13:52:00 +02001662tune.ssl.force-private-cache
1663 This boolean disables SSL session cache sharing between all processes. It
1664 should normally not be used since it will force many renegotiations due to
1665 clients hitting a random process. But it may be required on some operating
1666 systems where none of the SSL cache synchronization method may be used. In
1667 this case, adding a first layer of hash-based load balancing before the SSL
1668 layer might limit the impact of the lack of session sharing.
1669
Emeric Brun4f65bff2012-11-16 15:11:00 +01001670tune.ssl.lifetime <timeout>
1671 Sets how long a cached SSL session may remain valid. This time is expressed
Jarno Huuskonen0e82b922014-04-12 18:22:19 +03001672 in seconds and defaults to 300 (5 min). It is important to understand that it
Emeric Brun4f65bff2012-11-16 15:11:00 +01001673 does not guarantee that sessions will last that long, because if the cache is
1674 full, the longest idle sessions will be purged despite their configured
1675 lifetime. The real usefulness of this setting is to prevent sessions from
1676 being used for too long.
1677
Willy Tarreaubfd59462013-02-21 07:46:09 +01001678tune.ssl.maxrecord <number>
1679 Sets the maximum amount of bytes passed to SSL_write() at a time. Default
1680 value 0 means there is no limit. Over SSL/TLS, the client can decipher the
1681 data only once it has received a full record. With large records, it means
1682 that clients might have to download up to 16kB of data before starting to
1683 process them. Limiting the value can improve page load times on browsers
1684 located over high latency or low bandwidth networks. It is suggested to find
1685 optimal values which fit into 1 or 2 TCP segments (generally 1448 bytes over
1686 Ethernet with TCP timestamps enabled, or 1460 when timestamps are disabled),
1687 keeping in mind that SSL/TLS add some overhead. Typical values of 1419 and
1688 2859 gave good results during tests. Use "strace -e trace=write" to find the
Davor Ocelice9ed2812017-12-25 17:49:28 +01001689 best value. HAProxy will automatically switch to this setting after an idle
Willy Tarreau7e312732014-02-12 16:35:14 +01001690 stream has been detected (see tune.idletimer above).
Willy Tarreaubfd59462013-02-21 07:46:09 +01001691
Remi Gacognef46cd6e2014-06-12 14:58:40 +02001692tune.ssl.default-dh-param <number>
1693 Sets the maximum size of the Diffie-Hellman parameters used for generating
1694 the ephemeral/temporary Diffie-Hellman key in case of DHE key exchange. The
1695 final size will try to match the size of the server's RSA (or DSA) key (e.g,
1696 a 2048 bits temporary DH key for a 2048 bits RSA key), but will not exceed
1697 this maximum value. Default value if 1024. Only 1024 or higher values are
1698 allowed. Higher values will increase the CPU load, and values greater than
1699 1024 bits are not supported by Java 7 and earlier clients. This value is not
Remi Gacogne47783ef2015-05-29 15:53:22 +02001700 used if static Diffie-Hellman parameters are supplied either directly
1701 in the certificate file or by using the ssl-dh-param-file parameter.
Remi Gacognef46cd6e2014-06-12 14:58:40 +02001702
Christopher Faulet31af49d2015-06-09 17:29:50 +02001703tune.ssl.ssl-ctx-cache-size <number>
1704 Sets the size of the cache used to store generated certificates to <number>
1705 entries. This is a LRU cache. Because generating a SSL certificate
1706 dynamically is expensive, they are cached. The default cache size is set to
1707 1000 entries.
1708
Thierry FOURNIER5bf77322017-02-25 12:45:22 +01001709tune.ssl.capture-cipherlist-size <number>
1710 Sets the maximum size of the buffer used for capturing client-hello cipher
1711 list. If the value is 0 (default value) the capture is disabled, otherwise
1712 a buffer is allocated for each SSL/TLS connection.
1713
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02001714tune.vars.global-max-size <size>
Christopher Fauletff2613e2016-11-09 11:36:17 +01001715tune.vars.proc-max-size <size>
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02001716tune.vars.reqres-max-size <size>
1717tune.vars.sess-max-size <size>
1718tune.vars.txn-max-size <size>
Christopher Fauletff2613e2016-11-09 11:36:17 +01001719 These five tunes help to manage the maximum amount of memory used by the
1720 variables system. "global" limits the overall amount of memory available for
1721 all scopes. "proc" limits the memory for the process scope, "sess" limits the
1722 memory for the session scope, "txn" for the transaction scope, and "reqres"
1723 limits the memory for each request or response processing.
1724 Memory accounting is hierarchical, meaning more coarse grained limits include
1725 the finer grained ones: "proc" includes "sess", "sess" includes "txn", and
1726 "txn" includes "reqres".
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02001727
Daniel Schneller0b547052016-03-21 20:46:57 +01001728 For example, when "tune.vars.sess-max-size" is limited to 100,
1729 "tune.vars.txn-max-size" and "tune.vars.reqres-max-size" cannot exceed
1730 100 either. If we create a variable "txn.var" that contains 100 bytes,
1731 all available space is consumed.
1732 Notice that exceeding the limits at runtime will not result in an error
1733 message, but values might be cut off or corrupted. So make sure to accurately
1734 plan for the amount of space needed to store all your variables.
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02001735
William Lallemanda509e4c2012-11-07 16:54:34 +01001736tune.zlib.memlevel <number>
1737 Sets the memLevel parameter in zlib initialization for each session. It
Jarno Huuskonen0e82b922014-04-12 18:22:19 +03001738 defines how much memory should be allocated for the internal compression
William Lallemanda509e4c2012-11-07 16:54:34 +01001739 state. A value of 1 uses minimum memory but is slow and reduces compression
Davor Ocelice9ed2812017-12-25 17:49:28 +01001740 ratio, a value of 9 uses maximum memory for optimal speed. Can be a value
William Lallemanda509e4c2012-11-07 16:54:34 +01001741 between 1 and 9. The default value is 8.
1742
1743tune.zlib.windowsize <number>
1744 Sets the window size (the size of the history buffer) as a parameter of the
1745 zlib initialization for each session. Larger values of this parameter result
Davor Ocelice9ed2812017-12-25 17:49:28 +01001746 in better compression at the expense of memory usage. Can be a value between
1747 8 and 15. The default value is 15.
Willy Tarreau6a06a402007-07-15 20:15:28 +02001748
Willy Tarreauc57f0e22009-05-10 13:12:33 +020017493.3. Debugging
1750--------------
Willy Tarreau6a06a402007-07-15 20:15:28 +02001751
1752debug
1753 Enables debug mode which dumps to stdout all exchanges, and disables forking
1754 into background. It is the equivalent of the command-line argument "-d". It
1755 should never be used in a production configuration since it may prevent full
1756 system startup.
1757
1758quiet
1759 Do not display any message during startup. It is equivalent to the command-
1760 line argument "-q".
1761
Emeric Brunf099e792010-09-27 12:05:28 +02001762
Krzysztof Piotr Oledzki6b35ce12010-02-01 23:35:44 +010017633.4. Userlists
1764--------------
1765It is possible to control access to frontend/backend/listen sections or to
1766http stats by allowing only authenticated and authorized users. To do this,
1767it is required to create at least one userlist and to define users.
1768
1769userlist <listname>
Cyril Bonté78caf842010-03-10 22:41:43 +01001770 Creates new userlist with name <listname>. Many independent userlists can be
Krzysztof Piotr Oledzki6b35ce12010-02-01 23:35:44 +01001771 used to store authentication & authorization data for independent customers.
1772
1773group <groupname> [users <user>,<user>,(...)]
Cyril Bonté78caf842010-03-10 22:41:43 +01001774 Adds group <groupname> to the current userlist. It is also possible to
Krzysztof Piotr Oledzki6b35ce12010-02-01 23:35:44 +01001775 attach users to this group by using a comma separated list of names
1776 proceeded by "users" keyword.
1777
Cyril Bontéf0c60612010-02-06 14:44:47 +01001778user <username> [password|insecure-password <password>]
1779 [groups <group>,<group>,(...)]
Krzysztof Piotr Oledzki6b35ce12010-02-01 23:35:44 +01001780 Adds user <username> to the current userlist. Both secure (encrypted) and
1781 insecure (unencrypted) passwords can be used. Encrypted passwords are
Daniel Schnellerd06f31c2017-11-06 16:51:04 +01001782 evaluated using the crypt(3) function, so depending on the system's
1783 capabilities, different algorithms are supported. For example, modern Glibc
1784 based Linux systems support MD5, SHA-256, SHA-512, and, of course, the
1785 classic DES-based method of encrypting passwords.
Krzysztof Piotr Oledzki6b35ce12010-02-01 23:35:44 +01001786
Daniel Schnellerd06f31c2017-11-06 16:51:04 +01001787 Attention: Be aware that using encrypted passwords might cause significantly
1788 increased CPU usage, depending on the number of requests, and the algorithm
1789 used. For any of the hashed variants, the password for each request must
1790 be processed through the chosen algorithm, before it can be compared to the
1791 value specified in the config file. Most current algorithms are deliberately
1792 designed to be expensive to compute to achieve resistance against brute
1793 force attacks. They do not simply salt/hash the clear text password once,
1794 but thousands of times. This can quickly become a major factor in haproxy's
1795 overall CPU consumption!
Krzysztof Piotr Oledzki6b35ce12010-02-01 23:35:44 +01001796
1797 Example:
Cyril Bontéf0c60612010-02-06 14:44:47 +01001798 userlist L1
1799 group G1 users tiger,scott
1800 group G2 users xdb,scott
Krzysztof Piotr Oledzki6b35ce12010-02-01 23:35:44 +01001801
Cyril Bontéf0c60612010-02-06 14:44:47 +01001802 user tiger password $6$k6y3o.eP$JlKBx9za9667qe4(...)xHSwRv6J.C0/D7cV91
1803 user scott insecure-password elgato
1804 user xdb insecure-password hello
Krzysztof Piotr Oledzki6b35ce12010-02-01 23:35:44 +01001805
Cyril Bontéf0c60612010-02-06 14:44:47 +01001806 userlist L2
1807 group G1
1808 group G2
Krzysztof Piotr Oledzki6b35ce12010-02-01 23:35:44 +01001809
Cyril Bontéf0c60612010-02-06 14:44:47 +01001810 user tiger password $6$k6y3o.eP$JlKBx(...)xHSwRv6J.C0/D7cV91 groups G1
1811 user scott insecure-password elgato groups G1,G2
1812 user xdb insecure-password hello groups G2
Krzysztof Piotr Oledzki6b35ce12010-02-01 23:35:44 +01001813
1814 Please note that both lists are functionally identical.
Willy Tarreau6a06a402007-07-15 20:15:28 +02001815
Emeric Brunf099e792010-09-27 12:05:28 +02001816
18173.5. Peers
Cyril Bontédc4d9032012-04-08 21:57:39 +02001818----------
Emeric Brun94900952015-06-11 18:25:54 +02001819It is possible to propagate entries of any data-types in stick-tables between
1820several haproxy instances over TCP connections in a multi-master fashion. Each
1821instance pushes its local updates and insertions to remote peers. The pushed
1822values overwrite remote ones without aggregation. Interrupted exchanges are
1823automatically detected and recovered from the last known point.
1824In addition, during a soft restart, the old process connects to the new one
1825using such a TCP connection to push all its entries before the new process
1826tries to connect to other peers. That ensures very fast replication during a
1827reload, it typically takes a fraction of a second even for large tables.
1828Note that Server IDs are used to identify servers remotely, so it is important
1829that configurations look similar or at least that the same IDs are forced on
1830each server on all participants.
Emeric Brunf099e792010-09-27 12:05:28 +02001831
1832peers <peersect>
Jamie Gloudon801a0a32012-08-25 00:18:33 -04001833 Creates a new peer list with name <peersect>. It is an independent section,
Emeric Brunf099e792010-09-27 12:05:28 +02001834 which is referenced by one or more stick-tables.
1835
Willy Tarreau77e4bd12015-05-01 20:02:17 +02001836disabled
1837 Disables a peers section. It disables both listening and any synchronization
1838 related to this section. This is provided to disable synchronization of stick
1839 tables without having to comment out all "peers" references.
1840
1841enable
1842 This re-enables a disabled peers section which was previously disabled.
1843
Emeric Brunf099e792010-09-27 12:05:28 +02001844peer <peername> <ip>:<port>
1845 Defines a peer inside a peers section.
1846 If <peername> is set to the local peer name (by default hostname, or forced
1847 using "-L" command line option), haproxy will listen for incoming remote peer
1848 connection on <ip>:<port>. Otherwise, <ip>:<port> defines where to connect to
1849 to join the remote peer, and <peername> is used at the protocol level to
1850 identify and validate the remote peer on the server side.
1851
1852 During a soft restart, local peer <ip>:<port> is used by the old instance to
1853 connect the new one and initiate a complete replication (teaching process).
1854
1855 It is strongly recommended to have the exact same peers declaration on all
1856 peers and to only rely on the "-L" command line argument to change the local
1857 peer name. This makes it easier to maintain coherent configuration files
1858 across all peers.
1859
William Lallemandb2f07452015-05-12 14:27:13 +02001860 You may want to reference some environment variables in the address
1861 parameter, see section 2.3 about environment variables.
Willy Tarreaudad36a32013-03-11 01:20:04 +01001862
Cyril Bontédc4d9032012-04-08 21:57:39 +02001863 Example:
Emeric Brunf099e792010-09-27 12:05:28 +02001864 peers mypeers
Willy Tarreauf7b30a92010-12-06 22:59:17 +01001865 peer haproxy1 192.168.0.1:1024
1866 peer haproxy2 192.168.0.2:1024
1867 peer haproxy3 10.2.0.1:1024
Emeric Brunf099e792010-09-27 12:05:28 +02001868
1869 backend mybackend
1870 mode tcp
1871 balance roundrobin
1872 stick-table type ip size 20k peers mypeers
1873 stick on src
1874
Willy Tarreauf7b30a92010-12-06 22:59:17 +01001875 server srv1 192.168.0.30:80
1876 server srv2 192.168.0.31:80
Emeric Brunf099e792010-09-27 12:05:28 +02001877
1878
Simon Horman51a1cf62015-02-03 13:00:44 +090018793.6. Mailers
1880------------
1881It is possible to send email alerts when the state of servers changes.
1882If configured email alerts are sent to each mailer that is configured
1883in a mailers section. Email is sent to mailers using SMTP.
1884
Pieter Baauw386a1272015-08-16 15:26:24 +02001885mailers <mailersect>
Simon Horman51a1cf62015-02-03 13:00:44 +09001886 Creates a new mailer list with the name <mailersect>. It is an
1887 independent section which is referenced by one or more proxies.
1888
1889mailer <mailername> <ip>:<port>
1890 Defines a mailer inside a mailers section.
1891
1892 Example:
1893 mailers mymailers
1894 mailer smtp1 192.168.0.1:587
1895 mailer smtp2 192.168.0.2:587
1896
1897 backend mybackend
1898 mode tcp
1899 balance roundrobin
1900
1901 email-alert mailers mymailers
1902 email-alert from test1@horms.org
1903 email-alert to test2@horms.org
1904
1905 server srv1 192.168.0.30:80
1906 server srv2 192.168.0.31:80
1907
Pieter Baauw235fcfc2016-02-13 15:33:40 +01001908timeout mail <time>
1909 Defines the time available for a mail/connection to be made and send to
1910 the mail-server. If not defined the default value is 10 seconds. To allow
1911 for at least two SYN-ACK packets to be send during initial TCP handshake it
1912 is advised to keep this value above 4 seconds.
1913
1914 Example:
1915 mailers mymailers
1916 timeout mail 20s
1917 mailer smtp1 192.168.0.1:587
Simon Horman51a1cf62015-02-03 13:00:44 +09001918
Willy Tarreauc57f0e22009-05-10 13:12:33 +020019194. Proxies
Willy Tarreau6a06a402007-07-15 20:15:28 +02001920----------
Willy Tarreau0ba27502007-12-24 16:55:16 +01001921
Willy Tarreau6a06a402007-07-15 20:15:28 +02001922Proxy configuration can be located in a set of sections :
William Lallemand6e62fb62015-04-28 16:55:23 +02001923 - defaults [<name>]
Willy Tarreau6a06a402007-07-15 20:15:28 +02001924 - frontend <name>
1925 - backend <name>
1926 - listen <name>
1927
1928A "defaults" section sets default parameters for all other sections following
1929its declaration. Those default parameters are reset by the next "defaults"
1930section. See below for the list of parameters which can be set in a "defaults"
Willy Tarreau0ba27502007-12-24 16:55:16 +01001931section. The name is optional but its use is encouraged for better readability.
Willy Tarreau6a06a402007-07-15 20:15:28 +02001932
1933A "frontend" section describes a set of listening sockets accepting client
1934connections.
1935
1936A "backend" section describes a set of servers to which the proxy will connect
1937to forward incoming connections.
1938
1939A "listen" section defines a complete proxy with its frontend and backend
1940parts combined in one section. It is generally useful for TCP-only traffic.
1941
Willy Tarreau0ba27502007-12-24 16:55:16 +01001942All proxy names must be formed from upper and lower case letters, digits,
1943'-' (dash), '_' (underscore) , '.' (dot) and ':' (colon). ACL names are
1944case-sensitive, which means that "www" and "WWW" are two different proxies.
1945
1946Historically, all proxy names could overlap, it just caused troubles in the
1947logs. Since the introduction of content switching, it is mandatory that two
1948proxies with overlapping capabilities (frontend/backend) have different names.
1949However, it is still permitted that a frontend and a backend share the same
1950name, as this configuration seems to be commonly encountered.
1951
1952Right now, two major proxy modes are supported : "tcp", also known as layer 4,
1953and "http", also known as layer 7. In layer 4 mode, HAProxy simply forwards
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +01001954bidirectional traffic between two sides. In layer 7 mode, HAProxy analyzes the
Willy Tarreau0ba27502007-12-24 16:55:16 +01001955protocol, and can interact with it by allowing, blocking, switching, adding,
1956modifying, or removing arbitrary contents in requests or responses, based on
1957arbitrary criteria.
1958
Willy Tarreau70dffda2014-01-30 03:07:23 +01001959In HTTP mode, the processing applied to requests and responses flowing over
1960a connection depends in the combination of the frontend's HTTP options and
1961the backend's. HAProxy supports 5 connection modes :
1962
1963 - KAL : keep alive ("option http-keep-alive") which is the default mode : all
1964 requests and responses are processed, and connections remain open but idle
1965 between responses and new requests.
1966
1967 - TUN: tunnel ("option http-tunnel") : this was the default mode for versions
1968 1.0 to 1.5-dev21 : only the first request and response are processed, and
1969 everything else is forwarded with no analysis at all. This mode should not
1970 be used as it creates lots of trouble with logging and HTTP processing.
1971
1972 - PCL: passive close ("option httpclose") : exactly the same as tunnel mode,
1973 but with "Connection: close" appended in both directions to try to make
1974 both ends close after the first request/response exchange.
1975
1976 - SCL: server close ("option http-server-close") : the server-facing
1977 connection is closed after the end of the response is received, but the
1978 client-facing connection remains open.
1979
1980 - FCL: forced close ("option forceclose") : the connection is actively closed
1981 after the end of the response.
1982
1983The effective mode that will be applied to a connection passing through a
1984frontend and a backend can be determined by both proxy modes according to the
1985following matrix, but in short, the modes are symmetric, keep-alive is the
1986weakest option and force close is the strongest.
1987
1988 Backend mode
1989
1990 | KAL | TUN | PCL | SCL | FCL
1991 ----+-----+-----+-----+-----+----
1992 KAL | KAL | TUN | PCL | SCL | FCL
1993 ----+-----+-----+-----+-----+----
1994 TUN | TUN | TUN | PCL | SCL | FCL
1995 Frontend ----+-----+-----+-----+-----+----
1996 mode PCL | PCL | PCL | PCL | FCL | FCL
1997 ----+-----+-----+-----+-----+----
1998 SCL | SCL | SCL | FCL | SCL | FCL
1999 ----+-----+-----+-----+-----+----
2000 FCL | FCL | FCL | FCL | FCL | FCL
2001
Willy Tarreau0ba27502007-12-24 16:55:16 +01002002
Willy Tarreau70dffda2014-01-30 03:07:23 +01002003
Willy Tarreauc57f0e22009-05-10 13:12:33 +020020044.1. Proxy keywords matrix
2005--------------------------
Willy Tarreau0ba27502007-12-24 16:55:16 +01002006
Willy Tarreauc57f0e22009-05-10 13:12:33 +02002007The following list of keywords is supported. Most of them may only be used in a
2008limited set of section types. Some of them are marked as "deprecated" because
2009they are inherited from an old syntax which may be confusing or functionally
2010limited, and there are new recommended keywords to replace them. Keywords
Davor Ocelice9ed2812017-12-25 17:49:28 +01002011marked with "(*)" can be optionally inverted using the "no" prefix, e.g. "no
Willy Tarreauc57f0e22009-05-10 13:12:33 +02002012option contstats". This makes sense when the option has been enabled by default
Willy Tarreau3842f002009-06-14 11:39:52 +02002013and must be disabled for a specific instance. Such options may also be prefixed
2014with "default" in order to restore default settings regardless of what has been
2015specified in a previous "defaults" section.
Willy Tarreau0ba27502007-12-24 16:55:16 +01002016
Willy Tarreau6a06a402007-07-15 20:15:28 +02002017
Willy Tarreau5c6f7b32010-02-26 13:34:29 +01002018 keyword defaults frontend listen backend
2019------------------------------------+----------+----------+---------+---------
2020acl - X X X
Willy Tarreau294d0f02015-08-10 19:40:12 +02002021appsession - - - -
Willy Tarreau5c6f7b32010-02-26 13:34:29 +01002022backlog X X X -
2023balance X - X X
2024bind - X X -
2025bind-process X X X X
Jarno Huuskonen8c8c3492016-12-28 18:50:29 +02002026block (deprecated) - X X X
Willy Tarreau5c6f7b32010-02-26 13:34:29 +01002027capture cookie - X X -
2028capture request header - X X -
2029capture response header - X X -
2030clitimeout (deprecated) X X X -
William Lallemand82fe75c2012-10-23 10:25:10 +02002031compression X X X X
Willy Tarreau5c6f7b32010-02-26 13:34:29 +01002032contimeout (deprecated) X - X X
2033cookie X - X X
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +02002034declare capture - X X -
Willy Tarreau5c6f7b32010-02-26 13:34:29 +01002035default-server X - X X
2036default_backend X X X -
2037description - X X X
2038disabled X X X X
2039dispatch - - X X
Simon Horman51a1cf62015-02-03 13:00:44 +09002040email-alert from X X X X
Simon Horman64e34162015-02-06 11:11:57 +09002041email-alert level X X X X
Simon Horman51a1cf62015-02-03 13:00:44 +09002042email-alert mailers X X X X
2043email-alert myhostname X X X X
2044email-alert to X X X X
Willy Tarreau5c6f7b32010-02-26 13:34:29 +01002045enabled X X X X
2046errorfile X X X X
2047errorloc X X X X
2048errorloc302 X X X X
2049-- keyword -------------------------- defaults - frontend - listen -- backend -
2050errorloc303 X X X X
Cyril Bonté4288c5a2018-03-12 22:02:59 +01002051force-persist - - X X
Christopher Fauletc3fe5332016-04-07 15:30:10 +02002052filter - X X X
Willy Tarreau5c6f7b32010-02-26 13:34:29 +01002053fullconn X - X X
2054grace X X X X
2055hash-type X - X X
2056http-check disable-on-404 X - X X
Willy Tarreaubd741542010-03-16 18:46:54 +01002057http-check expect - - X X
Willy Tarreau7ab6aff2010-10-12 06:30:16 +02002058http-check send-state X - X X
Willy Tarreau5c6f7b32010-02-26 13:34:29 +01002059http-request - X X X
Willy Tarreaue365c0b2013-06-11 16:06:12 +02002060http-response - X X X
Willy Tarreau30631952015-08-06 15:05:24 +02002061http-reuse X - X X
Baptiste Assmann2c42ef52013-10-09 21:57:02 +02002062http-send-name-header - - X X
Willy Tarreau5c6f7b32010-02-26 13:34:29 +01002063id - X X X
Cyril Bonté4288c5a2018-03-12 22:02:59 +01002064ignore-persist - - X X
Baptiste Assmann01c6cc32015-08-23 11:45:29 +02002065load-server-state-from-file X - X X
William Lallemand0f99e342011-10-12 17:50:54 +02002066log (*) X X X X
Willy Tarreaufb4e7ea2015-01-07 14:55:17 +01002067log-format X X X -
Dragan Dosen7ad31542015-09-28 17:16:47 +02002068log-format-sd X X X -
Willy Tarreau094af4e2015-01-07 15:03:42 +01002069log-tag X X X X
Willy Tarreauc35362a2014-04-25 13:58:37 +02002070max-keep-alive-queue X - X X
Willy Tarreau5c6f7b32010-02-26 13:34:29 +01002071maxconn X X X -
2072mode X X X X
2073monitor fail - X X -
2074monitor-net X X X -
2075monitor-uri X X X -
2076option abortonclose (*) X - X X
2077option accept-invalid-http-request (*) X X X -
2078option accept-invalid-http-response (*) X - X X
2079option allbackups (*) X - X X
2080option checkcache (*) X - X X
2081option clitcpka (*) X X X -
2082option contstats (*) X X X -
2083option dontlog-normal (*) X X X -
2084option dontlognull (*) X X X -
2085option forceclose (*) X X X X
2086-- keyword -------------------------- defaults - frontend - listen -- backend -
2087option forwardfor X X X X
Willy Tarreau9fbe18e2015-05-01 22:42:08 +02002088option http-buffer-request (*) X X X X
Willy Tarreau82649f92015-05-01 22:40:51 +02002089option http-ignore-probes (*) X X X -
Willy Tarreau16bfb022010-01-16 19:48:41 +01002090option http-keep-alive (*) X X X X
Willy Tarreau96e31212011-05-30 18:10:30 +02002091option http-no-delay (*) X X X X
Willy Tarreau8a8e1d92010-04-05 16:15:16 +02002092option http-pretend-keepalive (*) X X X X
Willy Tarreau5c6f7b32010-02-26 13:34:29 +01002093option http-server-close (*) X X X X
Willy Tarreau02bce8b2014-01-30 00:15:28 +01002094option http-tunnel (*) X X X X
Willy Tarreau5c6f7b32010-02-26 13:34:29 +01002095option http-use-proxy-header (*) X X X -
2096option httpchk X - X X
2097option httpclose (*) X X X X
2098option httplog X X X X
2099option http_proxy (*) X X X X
Jamie Gloudon801a0a32012-08-25 00:18:33 -04002100option independent-streams (*) X X X X
Gabor Lekenyb4c81e42010-09-29 18:17:05 +02002101option ldap-check X - X X
Simon Horman98637e52014-06-20 12:30:16 +09002102option external-check X - X X
Willy Tarreau5c6f7b32010-02-26 13:34:29 +01002103option log-health-checks (*) X - X X
2104option log-separate-errors (*) X X X -
2105option logasap (*) X X X -
2106option mysql-check X - X X
2107option nolinger (*) X X X X
2108option originalto X X X X
2109option persist (*) X - X X
Baptiste Assmann809e22a2015-10-12 20:22:55 +02002110option pgsql-check X - X X
2111option prefer-last-server (*) X - X X
Willy Tarreau5c6f7b32010-02-26 13:34:29 +01002112option redispatch (*) X - X X
Hervé COMMOWICKec032d62011-08-05 16:23:48 +02002113option redis-check X - X X
Willy Tarreau5c6f7b32010-02-26 13:34:29 +01002114option smtpchk X - X X
2115option socket-stats (*) X X X -
2116option splice-auto (*) X X X X
2117option splice-request (*) X X X X
2118option splice-response (*) X X X X
Christopher Fauletba7bc162016-11-07 21:07:38 +01002119option spop-check - - - X
Willy Tarreau5c6f7b32010-02-26 13:34:29 +01002120option srvtcpka (*) X - X X
2121option ssl-hello-chk X - X X
2122-- keyword -------------------------- defaults - frontend - listen -- backend -
Willy Tarreaued179852013-12-16 01:07:00 +01002123option tcp-check X - X X
Willy Tarreau5c6f7b32010-02-26 13:34:29 +01002124option tcp-smart-accept (*) X X X -
2125option tcp-smart-connect (*) X - X X
2126option tcpka X X X X
2127option tcplog X X X X
2128option transparent (*) X - X X
Simon Horman98637e52014-06-20 12:30:16 +09002129external-check command X - X X
2130external-check path X - X X
Willy Tarreau5c6f7b32010-02-26 13:34:29 +01002131persist rdp-cookie X - X X
2132rate-limit sessions X X X -
2133redirect - X X X
2134redisp (deprecated) X - X X
2135redispatch (deprecated) X - X X
2136reqadd - X X X
2137reqallow - X X X
2138reqdel - X X X
2139reqdeny - X X X
2140reqiallow - X X X
2141reqidel - X X X
2142reqideny - X X X
2143reqipass - X X X
2144reqirep - X X X
Willy Tarreau5c6f7b32010-02-26 13:34:29 +01002145reqitarpit - X X X
2146reqpass - X X X
2147reqrep - X X X
2148-- keyword -------------------------- defaults - frontend - listen -- backend -
Willy Tarreau5c6f7b32010-02-26 13:34:29 +01002149reqtarpit - X X X
2150retries X - X X
2151rspadd - X X X
2152rspdel - X X X
2153rspdeny - X X X
2154rspidel - X X X
2155rspideny - X X X
2156rspirep - X X X
2157rsprep - X X X
2158server - - X X
Baptiste Assmann01c6cc32015-08-23 11:45:29 +02002159server-state-file-name X - X X
Frédéric Lécaillecb4502e2017-04-20 13:36:25 +02002160server-template - - X X
Willy Tarreau5c6f7b32010-02-26 13:34:29 +01002161source X - X X
2162srvtimeout (deprecated) X - X X
Baptiste Assmann5a549212015-10-12 20:30:24 +02002163stats admin - X X X
2164stats auth X X X X
2165stats enable X X X X
2166stats hide-version X X X X
2167stats http-request - X X X
2168stats realm X X X X
2169stats refresh X X X X
2170stats scope X X X X
2171stats show-desc X X X X
2172stats show-legends X X X X
2173stats show-node X X X X
2174stats uri X X X X
Willy Tarreau5c6f7b32010-02-26 13:34:29 +01002175-- keyword -------------------------- defaults - frontend - listen -- backend -
2176stick match - - X X
2177stick on - - X X
2178stick store-request - - X X
Willy Tarreaud8dc99f2011-07-01 11:33:25 +02002179stick store-response - - X X
Adam Spiers68af3c12017-04-06 16:31:39 +01002180stick-table - X X X
Willy Tarreau938c7fe2014-04-25 14:21:39 +02002181tcp-check connect - - X X
2182tcp-check expect - - X X
2183tcp-check send - - X X
2184tcp-check send-binary - - X X
Willy Tarreaue9656522010-08-17 15:40:09 +02002185tcp-request connection - X X -
2186tcp-request content - X X X
Willy Tarreaua56235c2010-09-14 11:31:36 +02002187tcp-request inspect-delay - X X X
Willy Tarreau4f614292016-10-21 17:49:36 +02002188tcp-request session - X X -
Emeric Brun0a3b67f2010-09-24 15:34:53 +02002189tcp-response content - - X X
2190tcp-response inspect-delay - - X X
Willy Tarreau5c6f7b32010-02-26 13:34:29 +01002191timeout check X - X X
2192timeout client X X X -
Willy Tarreau05cdd962014-05-10 14:30:07 +02002193timeout client-fin X X X -
Willy Tarreau5c6f7b32010-02-26 13:34:29 +01002194timeout clitimeout (deprecated) X X X -
2195timeout connect X - X X
2196timeout contimeout (deprecated) X - X X
2197timeout http-keep-alive X X X X
2198timeout http-request X X X X
2199timeout queue X - X X
2200timeout server X - X X
Willy Tarreau05cdd962014-05-10 14:30:07 +02002201timeout server-fin X - X X
Willy Tarreau5c6f7b32010-02-26 13:34:29 +01002202timeout srvtimeout (deprecated) X - X X
2203timeout tarpit X X X X
Willy Tarreauce887fd2012-05-12 12:50:00 +02002204timeout tunnel X - X X
Willy Tarreau5c6f7b32010-02-26 13:34:29 +01002205transparent (deprecated) X - X X
William Lallemanda73203e2012-03-12 12:48:57 +01002206unique-id-format X X X -
2207unique-id-header X X X -
Willy Tarreau5c6f7b32010-02-26 13:34:29 +01002208use_backend - X X -
Willy Tarreau4a5cade2012-04-05 21:09:48 +02002209use-server - - X X
Willy Tarreau5c6f7b32010-02-26 13:34:29 +01002210------------------------------------+----------+----------+---------+---------
2211 keyword defaults frontend listen backend
Willy Tarreau6a06a402007-07-15 20:15:28 +02002212
Willy Tarreau0ba27502007-12-24 16:55:16 +01002213
Willy Tarreauc57f0e22009-05-10 13:12:33 +020022144.2. Alphabetically sorted keywords reference
2215---------------------------------------------
Willy Tarreau0ba27502007-12-24 16:55:16 +01002216
2217This section provides a description of each keyword and its usage.
2218
2219
2220acl <aclname> <criterion> [flags] [operator] <value> ...
2221 Declare or complete an access list.
2222 May be used in sections : defaults | frontend | listen | backend
2223 no | yes | yes | yes
2224 Example:
2225 acl invalid_src src 0.0.0.0/7 224.0.0.0/3
2226 acl invalid_src src_port 0:1023
2227 acl local_dst hdr(host) -i localhost
2228
Willy Tarreauc57f0e22009-05-10 13:12:33 +02002229 See section 7 about ACL usage.
Willy Tarreau0ba27502007-12-24 16:55:16 +01002230
2231
Cyril Bontéb21570a2009-11-29 20:04:48 +01002232appsession <cookie> len <length> timeout <holdtime>
2233 [request-learn] [prefix] [mode <path-parameters|query-string>]
Willy Tarreau0ba27502007-12-24 16:55:16 +01002234 Define session stickiness on an existing application cookie.
2235 May be used in sections : defaults | frontend | listen | backend
2236 no | no | yes | yes
2237 Arguments :
2238 <cookie> this is the name of the cookie used by the application and which
2239 HAProxy will have to learn for each new session.
2240
Cyril Bontéb21570a2009-11-29 20:04:48 +01002241 <length> this is the max number of characters that will be memorized and
Willy Tarreau0ba27502007-12-24 16:55:16 +01002242 checked in each cookie value.
2243
2244 <holdtime> this is the time after which the cookie will be removed from
2245 memory if unused. If no unit is specified, this time is in
2246 milliseconds.
2247
Cyril Bontébf47aeb2009-10-15 00:15:40 +02002248 request-learn
2249 If this option is specified, then haproxy will be able to learn
2250 the cookie found in the request in case the server does not
2251 specify any in response. This is typically what happens with
2252 PHPSESSID cookies, or when haproxy's session expires before
2253 the application's session and the correct server is selected.
2254 It is recommended to specify this option to improve reliability.
2255
Cyril Bontéb21570a2009-11-29 20:04:48 +01002256 prefix When this option is specified, haproxy will match on the cookie
2257 prefix (or URL parameter prefix). The appsession value is the
2258 data following this prefix.
2259
2260 Example :
2261 appsession ASPSESSIONID len 64 timeout 3h prefix
2262
Davor Ocelice9ed2812017-12-25 17:49:28 +01002263 This will match the cookie ASPSESSIONIDXXX=XXXX,
2264 the appsession value will be XXX=XXXX.
Cyril Bontéb21570a2009-11-29 20:04:48 +01002265
2266 mode This option allows to change the URL parser mode.
2267 2 modes are currently supported :
2268 - path-parameters :
2269 The parser looks for the appsession in the path parameters
2270 part (each parameter is separated by a semi-colon), which is
2271 convenient for JSESSIONID for example.
2272 This is the default mode if the option is not set.
2273 - query-string :
2274 In this mode, the parser will look for the appsession in the
2275 query string.
2276
Willy Tarreau294d0f02015-08-10 19:40:12 +02002277 As of version 1.6, appsessions was removed. It is more flexible and more
2278 convenient to use stick-tables instead, and stick-tables support multi-master
2279 replication and data conservation across reloads, which appsessions did not.
Willy Tarreau0ba27502007-12-24 16:55:16 +01002280
Cyril Bonté02ff8ef2010-12-14 22:48:49 +01002281 See also : "cookie", "capture cookie", "balance", "stick", "stick-table",
2282 "ignore-persist", "nbproc" and "bind-process".
Willy Tarreau0ba27502007-12-24 16:55:16 +01002283
2284
Willy Tarreauc73ce2b2008-01-06 10:55:10 +01002285backlog <conns>
2286 Give hints to the system about the approximate listen backlog desired size
2287 May be used in sections : defaults | frontend | listen | backend
2288 yes | yes | yes | no
2289 Arguments :
2290 <conns> is the number of pending connections. Depending on the operating
2291 system, it may represent the number of already acknowledged
Cyril Bontédc4d9032012-04-08 21:57:39 +02002292 connections, of non-acknowledged ones, or both.
Willy Tarreauc73ce2b2008-01-06 10:55:10 +01002293
2294 In order to protect against SYN flood attacks, one solution is to increase
2295 the system's SYN backlog size. Depending on the system, sometimes it is just
2296 tunable via a system parameter, sometimes it is not adjustable at all, and
2297 sometimes the system relies on hints given by the application at the time of
2298 the listen() syscall. By default, HAProxy passes the frontend's maxconn value
2299 to the listen() syscall. On systems which can make use of this value, it can
2300 sometimes be useful to be able to specify a different value, hence this
2301 backlog parameter.
2302
2303 On Linux 2.4, the parameter is ignored by the system. On Linux 2.6, it is
2304 used as a hint and the system accepts up to the smallest greater power of
2305 two, and never more than some limits (usually 32768).
2306
2307 See also : "maxconn" and the target operating system's tuning guide.
2308
2309
Willy Tarreau0ba27502007-12-24 16:55:16 +01002310balance <algorithm> [ <arguments> ]
Willy Tarreau226071e2014-04-10 11:55:45 +02002311balance url_param <param> [check_post]
Willy Tarreau0ba27502007-12-24 16:55:16 +01002312 Define the load balancing algorithm to be used in a backend.
2313 May be used in sections : defaults | frontend | listen | backend
2314 yes | no | yes | yes
2315 Arguments :
2316 <algorithm> is the algorithm used to select a server when doing load
2317 balancing. This only applies when no persistence information
2318 is available, or when a connection is redispatched to another
2319 server. <algorithm> may be one of the following :
2320
2321 roundrobin Each server is used in turns, according to their weights.
2322 This is the smoothest and fairest algorithm when the server's
2323 processing time remains equally distributed. This algorithm
2324 is dynamic, which means that server weights may be adjusted
Willy Tarreau9757a382009-10-03 12:56:50 +02002325 on the fly for slow starts for instance. It is limited by
Godbacha34bdc02013-07-22 07:44:53 +08002326 design to 4095 active servers per backend. Note that in some
Willy Tarreau9757a382009-10-03 12:56:50 +02002327 large farms, when a server becomes up after having been down
2328 for a very short time, it may sometimes take a few hundreds
2329 requests for it to be re-integrated into the farm and start
2330 receiving traffic. This is normal, though very rare. It is
2331 indicated here in case you would have the chance to observe
2332 it, so that you don't worry.
2333
2334 static-rr Each server is used in turns, according to their weights.
2335 This algorithm is as similar to roundrobin except that it is
2336 static, which means that changing a server's weight on the
2337 fly will have no effect. On the other hand, it has no design
2338 limitation on the number of servers, and when a server goes
2339 up, it is always immediately reintroduced into the farm, once
2340 the full map is recomputed. It also uses slightly less CPU to
2341 run (around -1%).
Willy Tarreau0ba27502007-12-24 16:55:16 +01002342
Willy Tarreau2d2a7f82008-03-17 12:07:56 +01002343 leastconn The server with the lowest number of connections receives the
2344 connection. Round-robin is performed within groups of servers
2345 of the same load to ensure that all servers will be used. Use
2346 of this algorithm is recommended where very long sessions are
2347 expected, such as LDAP, SQL, TSE, etc... but is not very well
2348 suited for protocols using short sessions such as HTTP. This
2349 algorithm is dynamic, which means that server weights may be
2350 adjusted on the fly for slow starts for instance.
2351
Willy Tarreauf09c6602012-02-13 17:12:08 +01002352 first The first server with available connection slots receives the
Jarno Huuskonen0e82b922014-04-12 18:22:19 +03002353 connection. The servers are chosen from the lowest numeric
Willy Tarreauf09c6602012-02-13 17:12:08 +01002354 identifier to the highest (see server parameter "id"), which
2355 defaults to the server's position in the farm. Once a server
Willy Tarreau64559c52012-04-07 09:08:45 +02002356 reaches its maxconn value, the next server is used. It does
Willy Tarreauf09c6602012-02-13 17:12:08 +01002357 not make sense to use this algorithm without setting maxconn.
2358 The purpose of this algorithm is to always use the smallest
2359 number of servers so that extra servers can be powered off
2360 during non-intensive hours. This algorithm ignores the server
2361 weight, and brings more benefit to long session such as RDP
Willy Tarreau64559c52012-04-07 09:08:45 +02002362 or IMAP than HTTP, though it can be useful there too. In
2363 order to use this algorithm efficiently, it is recommended
2364 that a cloud controller regularly checks server usage to turn
2365 them off when unused, and regularly checks backend queue to
2366 turn new servers on when the queue inflates. Alternatively,
2367 using "http-check send-state" may inform servers on the load.
Willy Tarreauf09c6602012-02-13 17:12:08 +01002368
Willy Tarreau0ba27502007-12-24 16:55:16 +01002369 source The source IP address is hashed and divided by the total
2370 weight of the running servers to designate which server will
2371 receive the request. This ensures that the same client IP
2372 address will always reach the same server as long as no
2373 server goes down or up. If the hash result changes due to the
2374 number of running servers changing, many clients will be
2375 directed to a different server. This algorithm is generally
2376 used in TCP mode where no cookie may be inserted. It may also
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +01002377 be used on the Internet to provide a best-effort stickiness
Willy Tarreau0ba27502007-12-24 16:55:16 +01002378 to clients which refuse session cookies. This algorithm is
Willy Tarreau6b2e11b2009-10-01 07:52:15 +02002379 static by default, which means that changing a server's
2380 weight on the fly will have no effect, but this can be
2381 changed using "hash-type".
Willy Tarreau0ba27502007-12-24 16:55:16 +01002382
Oskar Stolc8dc41842012-05-19 10:19:54 +01002383 uri This algorithm hashes either the left part of the URI (before
2384 the question mark) or the whole URI (if the "whole" parameter
2385 is present) and divides the hash value by the total weight of
2386 the running servers. The result designates which server will
2387 receive the request. This ensures that the same URI will
2388 always be directed to the same server as long as no server
2389 goes up or down. This is used with proxy caches and
2390 anti-virus proxies in order to maximize the cache hit rate.
2391 Note that this algorithm may only be used in an HTTP backend.
2392 This algorithm is static by default, which means that
2393 changing a server's weight on the fly will have no effect,
2394 but this can be changed using "hash-type".
Willy Tarreau0ba27502007-12-24 16:55:16 +01002395
Oskar Stolc8dc41842012-05-19 10:19:54 +01002396 This algorithm supports two optional parameters "len" and
Marek Majkowski9c30fc12008-04-27 23:25:55 +02002397 "depth", both followed by a positive integer number. These
2398 options may be helpful when it is needed to balance servers
2399 based on the beginning of the URI only. The "len" parameter
2400 indicates that the algorithm should only consider that many
2401 characters at the beginning of the URI to compute the hash.
2402 Note that having "len" set to 1 rarely makes sense since most
2403 URIs start with a leading "/".
2404
2405 The "depth" parameter indicates the maximum directory depth
2406 to be used to compute the hash. One level is counted for each
2407 slash in the request. If both parameters are specified, the
2408 evaluation stops when either is reached.
2409
Willy Tarreau0ba27502007-12-24 16:55:16 +01002410 url_param The URL parameter specified in argument will be looked up in
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +02002411 the query string of each HTTP GET request.
2412
2413 If the modifier "check_post" is used, then an HTTP POST
Cyril Bontédc4d9032012-04-08 21:57:39 +02002414 request entity will be searched for the parameter argument,
2415 when it is not found in a query string after a question mark
Willy Tarreau226071e2014-04-10 11:55:45 +02002416 ('?') in the URL. The message body will only start to be
2417 analyzed once either the advertised amount of data has been
2418 received or the request buffer is full. In the unlikely event
2419 that chunked encoding is used, only the first chunk is
Cyril Bontédc4d9032012-04-08 21:57:39 +02002420 scanned. Parameter values separated by a chunk boundary, may
Willy Tarreau226071e2014-04-10 11:55:45 +02002421 be randomly balanced if at all. This keyword used to support
2422 an optional <max_wait> parameter which is now ignored.
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +02002423
2424 If the parameter is found followed by an equal sign ('=') and
2425 a value, then the value is hashed and divided by the total
2426 weight of the running servers. The result designates which
2427 server will receive the request.
2428
2429 This is used to track user identifiers in requests and ensure
2430 that a same user ID will always be sent to the same server as
2431 long as no server goes up or down. If no value is found or if
2432 the parameter is not found, then a round robin algorithm is
2433 applied. Note that this algorithm may only be used in an HTTP
Willy Tarreau6b2e11b2009-10-01 07:52:15 +02002434 backend. This algorithm is static by default, which means
2435 that changing a server's weight on the fly will have no
2436 effect, but this can be changed using "hash-type".
Willy Tarreau0ba27502007-12-24 16:55:16 +01002437
Cyril Bontédc4d9032012-04-08 21:57:39 +02002438 hdr(<name>) The HTTP header <name> will be looked up in each HTTP
2439 request. Just as with the equivalent ACL 'hdr()' function,
2440 the header name in parenthesis is not case sensitive. If the
2441 header is absent or if it does not contain any value, the
2442 roundrobin algorithm is applied instead.
Benoitaffb4812009-03-25 13:02:10 +01002443
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +01002444 An optional 'use_domain_only' parameter is available, for
Benoitaffb4812009-03-25 13:02:10 +01002445 reducing the hash algorithm to the main domain part with some
2446 specific headers such as 'Host'. For instance, in the Host
2447 value "haproxy.1wt.eu", only "1wt" will be considered.
2448
Willy Tarreau6b2e11b2009-10-01 07:52:15 +02002449 This algorithm is static by default, which means that
2450 changing a server's weight on the fly will have no effect,
2451 but this can be changed using "hash-type".
2452
Willy Tarreau760e81d2018-05-03 07:20:40 +02002453 random A random number will be used as the key for the consistent
2454 hashing function. This means that the servers' weights are
2455 respected, dynamic weight changes immediately take effect, as
2456 well as new server additions. Random load balancing can be
2457 useful with large farms or when servers are frequently added
2458 or removed. The hash-balance-factor directive can be used to
2459 further improve fairness of the load balancing, especially
2460 in situations where servers show highly variable response
2461 times.
2462
Emeric Brun736aa232009-06-30 17:56:00 +02002463 rdp-cookie
Hervé COMMOWICKa3eb39c2011-08-05 18:48:51 +02002464 rdp-cookie(<name>)
Emeric Brun736aa232009-06-30 17:56:00 +02002465 The RDP cookie <name> (or "mstshash" if omitted) will be
2466 looked up and hashed for each incoming TCP request. Just as
2467 with the equivalent ACL 'req_rdp_cookie()' function, the name
2468 is not case-sensitive. This mechanism is useful as a degraded
2469 persistence mode, as it makes it possible to always send the
2470 same user (or the same session ID) to the same server. If the
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +01002471 cookie is not found, the normal roundrobin algorithm is
Emeric Brun736aa232009-06-30 17:56:00 +02002472 used instead.
2473
2474 Note that for this to work, the frontend must ensure that an
2475 RDP cookie is already present in the request buffer. For this
2476 you must use 'tcp-request content accept' rule combined with
2477 a 'req_rdp_cookie_cnt' ACL.
2478
Willy Tarreau6b2e11b2009-10-01 07:52:15 +02002479 This algorithm is static by default, which means that
2480 changing a server's weight on the fly will have no effect,
2481 but this can be changed using "hash-type".
2482
Cyril Bontédc4d9032012-04-08 21:57:39 +02002483 See also the rdp_cookie pattern fetch function.
Simon Hormanab814e02011-06-24 14:50:20 +09002484
Willy Tarreau0ba27502007-12-24 16:55:16 +01002485 <arguments> is an optional list of arguments which may be needed by some
Marek Majkowski9c30fc12008-04-27 23:25:55 +02002486 algorithms. Right now, only "url_param" and "uri" support an
2487 optional argument.
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +02002488
Willy Tarreau3cd9af22009-03-15 14:06:41 +01002489 The load balancing algorithm of a backend is set to roundrobin when no other
2490 algorithm, mode nor option have been set. The algorithm may only be set once
2491 for each backend.
Willy Tarreau0ba27502007-12-24 16:55:16 +01002492
2493 Examples :
2494 balance roundrobin
2495 balance url_param userid
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +02002496 balance url_param session_id check_post 64
Benoitaffb4812009-03-25 13:02:10 +01002497 balance hdr(User-Agent)
2498 balance hdr(host)
2499 balance hdr(Host) use_domain_only
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +02002500
2501 Note: the following caveats and limitations on using the "check_post"
2502 extension with "url_param" must be considered :
2503
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +01002504 - all POST requests are eligible for consideration, because there is no way
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +02002505 to determine if the parameters will be found in the body or entity which
2506 may contain binary data. Therefore another method may be required to
2507 restrict consideration of POST requests that have no URL parameters in
2508 the body. (see acl reqideny http_end)
2509
2510 - using a <max_wait> value larger than the request buffer size does not
2511 make sense and is useless. The buffer size is set at build time, and
2512 defaults to 16 kB.
2513
2514 - Content-Encoding is not supported, the parameter search will probably
2515 fail; and load balancing will fall back to Round Robin.
2516
2517 - Expect: 100-continue is not supported, load balancing will fall back to
2518 Round Robin.
2519
Lukas Tribus23953682017-04-28 13:24:30 +00002520 - Transfer-Encoding (RFC7230 3.3.1) is only supported in the first chunk.
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +02002521 If the entire parameter value is not present in the first chunk, the
2522 selection of server is undefined (actually, defined by how little
2523 actually appeared in the first chunk).
2524
2525 - This feature does not support generation of a 100, 411 or 501 response.
2526
2527 - In some cases, requesting "check_post" MAY attempt to scan the entire
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +01002528 contents of a message body. Scanning normally terminates when linear
matt.farnsworth@nokia.com1c2ab962008-04-14 20:47:37 +02002529 white space or control characters are found, indicating the end of what
2530 might be a URL parameter list. This is probably not a concern with SGML
2531 type message bodies.
Willy Tarreau0ba27502007-12-24 16:55:16 +01002532
Willy Tarreau294d0f02015-08-10 19:40:12 +02002533 See also : "dispatch", "cookie", "transparent", "hash-type" and "http_proxy".
Willy Tarreau0ba27502007-12-24 16:55:16 +01002534
2535
Willy Tarreaub6205fd2012-09-24 12:27:33 +02002536bind [<address>]:<port_range> [, ...] [param*]
2537bind /<path> [, ...] [param*]
Willy Tarreau0ba27502007-12-24 16:55:16 +01002538 Define one or several listening addresses and/or ports in a frontend.
2539 May be used in sections : defaults | frontend | listen | backend
2540 no | yes | yes | no
2541 Arguments :
Willy Tarreaub1e52e82008-01-13 14:49:51 +01002542 <address> is optional and can be a host name, an IPv4 address, an IPv6
2543 address, or '*'. It designates the address the frontend will
2544 listen on. If unset, all IPv4 addresses of the system will be
2545 listened on. The same will apply for '*' or the system's
David du Colombier9c938da2011-03-17 10:40:27 +01002546 special address "0.0.0.0". The IPv6 equivalent is '::'.
Willy Tarreau24709282013-03-10 21:32:12 +01002547 Optionally, an address family prefix may be used before the
2548 address to force the family regardless of the address format,
2549 which can be useful to specify a path to a unix socket with
2550 no slash ('/'). Currently supported prefixes are :
2551 - 'ipv4@' -> address is always IPv4
2552 - 'ipv6@' -> address is always IPv6
2553 - 'unix@' -> address is a path to a local unix socket
Willy Tarreau70f72e02014-07-08 00:37:50 +02002554 - 'abns@' -> address is in abstract namespace (Linux only).
2555 Note: since abstract sockets are not "rebindable", they
2556 do not cope well with multi-process mode during
2557 soft-restart, so it is better to avoid them if
2558 nbproc is greater than 1. The effect is that if the
2559 new process fails to start, only one of the old ones
2560 will be able to rebind to the socket.
Willy Tarreau40aa0702013-03-10 23:51:38 +01002561 - 'fd@<n>' -> use file descriptor <n> inherited from the
2562 parent. The fd must be bound and may or may not already
2563 be listening.
William Lallemandb2f07452015-05-12 14:27:13 +02002564 You may want to reference some environment variables in the
2565 address parameter, see section 2.3 about environment
2566 variables.
Willy Tarreaub1e52e82008-01-13 14:49:51 +01002567
Willy Tarreauc5011ca2010-03-22 11:53:56 +01002568 <port_range> is either a unique TCP port, or a port range for which the
2569 proxy will accept connections for the IP address specified
Willy Tarreauceb24bc2010-11-09 12:46:41 +01002570 above. The port is mandatory for TCP listeners. Note that in
2571 the case of an IPv6 address, the port is always the number
2572 after the last colon (':'). A range can either be :
Willy Tarreauc5011ca2010-03-22 11:53:56 +01002573 - a numerical port (ex: '80')
2574 - a dash-delimited ports range explicitly stating the lower
2575 and upper bounds (ex: '2000-2100') which are included in
2576 the range.
2577
2578 Particular care must be taken against port ranges, because
2579 every <address:port> couple consumes one socket (= a file
2580 descriptor), so it's easy to consume lots of descriptors
2581 with a simple range, and to run out of sockets. Also, each
2582 <address:port> couple must be used only once among all
2583 instances running on a same system. Please note that binding
2584 to ports lower than 1024 generally require particular
Jamie Gloudon801a0a32012-08-25 00:18:33 -04002585 privileges to start the program, which are independent of
Willy Tarreauc5011ca2010-03-22 11:53:56 +01002586 the 'uid' parameter.
Willy Tarreau0ba27502007-12-24 16:55:16 +01002587
Willy Tarreauceb24bc2010-11-09 12:46:41 +01002588 <path> is a UNIX socket path beginning with a slash ('/'). This is
Davor Ocelice9ed2812017-12-25 17:49:28 +01002589 alternative to the TCP listening port. HAProxy will then
Willy Tarreauceb24bc2010-11-09 12:46:41 +01002590 receive UNIX connections on the socket located at this place.
2591 The path must begin with a slash and by default is absolute.
2592 It can be relative to the prefix defined by "unix-bind" in
2593 the global section. Note that the total length of the prefix
2594 followed by the socket path cannot exceed some system limits
2595 for UNIX sockets, which commonly are set to 107 characters.
2596
Willy Tarreaub6205fd2012-09-24 12:27:33 +02002597 <param*> is a list of parameters common to all sockets declared on the
2598 same line. These numerous parameters depend on OS and build
2599 options and have a complete section dedicated to them. Please
2600 refer to section 5 to for more details.
Willy Tarreaua0ee1d02012-09-10 09:01:23 +02002601
Willy Tarreau0ba27502007-12-24 16:55:16 +01002602 It is possible to specify a list of address:port combinations delimited by
2603 commas. The frontend will then listen on all of these addresses. There is no
2604 fixed limit to the number of addresses and ports which can be listened on in
2605 a frontend, as well as there is no limit to the number of "bind" statements
2606 in a frontend.
2607
2608 Example :
2609 listen http_proxy
2610 bind :80,:443
2611 bind 10.0.0.1:10080,10.0.0.1:10443
Willy Tarreauceb24bc2010-11-09 12:46:41 +01002612 bind /var/run/ssl-frontend.sock user root mode 600 accept-proxy
Willy Tarreau0ba27502007-12-24 16:55:16 +01002613
Willy Tarreaua0ee1d02012-09-10 09:01:23 +02002614 listen http_https_proxy
2615 bind :80
Cyril Bonté0d44fc62012-10-09 22:45:33 +02002616 bind :443 ssl crt /etc/haproxy/site.pem
Willy Tarreaua0ee1d02012-09-10 09:01:23 +02002617
Willy Tarreau24709282013-03-10 21:32:12 +01002618 listen http_https_proxy_explicit
2619 bind ipv6@:80
2620 bind ipv4@public_ssl:443 ssl crt /etc/haproxy/site.pem
2621 bind unix@ssl-frontend.sock user root mode 600 accept-proxy
2622
Willy Tarreaudad36a32013-03-11 01:20:04 +01002623 listen external_bind_app1
William Lallemandb2f07452015-05-12 14:27:13 +02002624 bind "fd@${FD_APP1}"
Willy Tarreaudad36a32013-03-11 01:20:04 +01002625
Willy Tarreau55dcaf62015-09-27 15:03:15 +02002626 Note: regarding Linux's abstract namespace sockets, HAProxy uses the whole
2627 sun_path length is used for the address length. Some other programs
2628 such as socat use the string length only by default. Pass the option
2629 ",unix-tightsocklen=0" to any abstract socket definition in socat to
2630 make it compatible with HAProxy's.
2631
Willy Tarreauceb24bc2010-11-09 12:46:41 +01002632 See also : "source", "option forwardfor", "unix-bind" and the PROXY protocol
Willy Tarreaub6205fd2012-09-24 12:27:33 +02002633 documentation, and section 5 about bind options.
Willy Tarreau0ba27502007-12-24 16:55:16 +01002634
2635
Christopher Fauletff4121f2017-11-22 16:38:49 +01002636bind-process [ all | odd | even | <process_num>[-[<process_num>]] ] ...
Willy Tarreau0b9c02c2009-02-04 22:05:05 +01002637 Limit visibility of an instance to a certain set of processes numbers.
2638 May be used in sections : defaults | frontend | listen | backend
2639 yes | yes | yes | yes
2640 Arguments :
2641 all All process will see this instance. This is the default. It
2642 may be used to override a default value.
2643
Willy Tarreaua9db57e2013-01-18 11:29:29 +01002644 odd This instance will be enabled on processes 1,3,5,...63. This
Willy Tarreau0b9c02c2009-02-04 22:05:05 +01002645 option may be combined with other numbers.
2646
Willy Tarreaua9db57e2013-01-18 11:29:29 +01002647 even This instance will be enabled on processes 2,4,6,...64. This
Willy Tarreau0b9c02c2009-02-04 22:05:05 +01002648 option may be combined with other numbers. Do not use it
2649 with less than 2 processes otherwise some instances might be
2650 missing from all processes.
2651
Christopher Fauletff4121f2017-11-22 16:38:49 +01002652 process_num The instance will be enabled on this process number or range,
Willy Tarreaua9db57e2013-01-18 11:29:29 +01002653 whose values must all be between 1 and 32 or 64 depending on
Christopher Fauletff4121f2017-11-22 16:38:49 +01002654 the machine's word size. Ranges can be partially defined. The
2655 higher bound can be omitted. In such case, it is replaced by
2656 the corresponding maximum value. If a proxy is bound to
2657 process numbers greater than the configured global.nbproc, it
2658 will either be forced to process #1 if a single process was
Willy Tarreau102df612014-05-07 23:56:38 +02002659 specified, or to all processes otherwise.
Willy Tarreau0b9c02c2009-02-04 22:05:05 +01002660
2661 This keyword limits binding of certain instances to certain processes. This
2662 is useful in order not to have too many processes listening to the same
2663 ports. For instance, on a dual-core machine, it might make sense to set
2664 'nbproc 2' in the global section, then distributes the listeners among 'odd'
2665 and 'even' instances.
2666
Willy Tarreaua9db57e2013-01-18 11:29:29 +01002667 At the moment, it is not possible to reference more than 32 or 64 processes
2668 using this keyword, but this should be more than enough for most setups.
2669 Please note that 'all' really means all processes regardless of the machine's
2670 word size, and is not limited to the first 32 or 64.
Willy Tarreau0b9c02c2009-02-04 22:05:05 +01002671
Willy Tarreau6ae1ba62014-05-07 19:01:58 +02002672 Each "bind" line may further be limited to a subset of the proxy's processes,
2673 please consult the "process" bind keyword in section 5.1.
2674
Willy Tarreaub369a042014-09-16 13:21:03 +02002675 When a frontend has no explicit "bind-process" line, it tries to bind to all
2676 the processes referenced by its "bind" lines. That means that frontends can
2677 easily adapt to their listeners' processes.
2678
Willy Tarreau0b9c02c2009-02-04 22:05:05 +01002679 If some backends are referenced by frontends bound to other processes, the
2680 backend automatically inherits the frontend's processes.
2681
2682 Example :
2683 listen app_ip1
2684 bind 10.0.0.1:80
Willy Tarreaubfcd3112010-10-23 11:22:08 +02002685 bind-process odd
Willy Tarreau0b9c02c2009-02-04 22:05:05 +01002686
2687 listen app_ip2
2688 bind 10.0.0.2:80
Willy Tarreaubfcd3112010-10-23 11:22:08 +02002689 bind-process even
Willy Tarreau0b9c02c2009-02-04 22:05:05 +01002690
2691 listen management
2692 bind 10.0.0.3:80
Willy Tarreaubfcd3112010-10-23 11:22:08 +02002693 bind-process 1 2 3 4
Willy Tarreau0b9c02c2009-02-04 22:05:05 +01002694
Willy Tarreau110ecc12012-11-15 17:50:01 +01002695 listen management
2696 bind 10.0.0.4:80
2697 bind-process 1-4
2698
Willy Tarreau6ae1ba62014-05-07 19:01:58 +02002699 See also : "nbproc" in global section, and "process" in section 5.1.
Willy Tarreau0b9c02c2009-02-04 22:05:05 +01002700
2701
Jarno Huuskonen8c8c3492016-12-28 18:50:29 +02002702block { if | unless } <condition> (deprecated)
Willy Tarreau0ba27502007-12-24 16:55:16 +01002703 Block a layer 7 request if/unless a condition is matched
2704 May be used in sections : defaults | frontend | listen | backend
2705 no | yes | yes | yes
2706
2707 The HTTP request will be blocked very early in the layer 7 processing
2708 if/unless <condition> is matched. A 403 error will be returned if the request
Willy Tarreauc57f0e22009-05-10 13:12:33 +02002709 is blocked. The condition has to reference ACLs (see section 7). This is
Willy Tarreau3c92c5f2011-08-28 09:45:47 +02002710 typically used to deny access to certain sensitive resources if some
Willy Tarreau0ba27502007-12-24 16:55:16 +01002711 conditions are met or not met. There is no fixed limit to the number of
Jarno Huuskonen95b012b2017-04-06 13:59:14 +03002712 "block" statements per instance. To block connections at layer 4 (without
2713 sending a 403 error) see "tcp-request connection reject" and
2714 "tcp-request content reject" rules.
Willy Tarreau0ba27502007-12-24 16:55:16 +01002715
Jarno Huuskonen8c8c3492016-12-28 18:50:29 +02002716 This form is deprecated, do not use it in any new configuration, use the new
2717 "http-request deny" instead.
2718
Willy Tarreau0ba27502007-12-24 16:55:16 +01002719 Example:
2720 acl invalid_src src 0.0.0.0/7 224.0.0.0/3
2721 acl invalid_src src_port 0:1023
2722 acl local_dst hdr(host) -i localhost
Jarno Huuskonen84c51ec2017-04-03 14:20:34 +03002723 # block is deprecated. Use http-request deny instead:
2724 #block if invalid_src || local_dst
2725 http-request deny if invalid_src || local_dst
Willy Tarreau0ba27502007-12-24 16:55:16 +01002726
Jarno Huuskonen95b012b2017-04-06 13:59:14 +03002727 See also : section 7 about ACL usage, "http-request deny",
2728 "http-response deny", "tcp-request connection reject" and
2729 "tcp-request content reject".
Willy Tarreau0ba27502007-12-24 16:55:16 +01002730
2731capture cookie <name> len <length>
2732 Capture and log a cookie in the request and in the response.
2733 May be used in sections : defaults | frontend | listen | backend
2734 no | yes | yes | no
2735 Arguments :
2736 <name> is the beginning of the name of the cookie to capture. In order
2737 to match the exact name, simply suffix the name with an equal
2738 sign ('='). The full name will appear in the logs, which is
2739 useful with application servers which adjust both the cookie name
Davor Ocelice9ed2812017-12-25 17:49:28 +01002740 and value (e.g. ASPSESSIONXXX).
Willy Tarreau0ba27502007-12-24 16:55:16 +01002741
2742 <length> is the maximum number of characters to report in the logs, which
2743 include the cookie name, the equal sign and the value, all in the
2744 standard "name=value" form. The string will be truncated on the
2745 right if it exceeds <length>.
2746
2747 Only the first cookie is captured. Both the "cookie" request headers and the
2748 "set-cookie" response headers are monitored. This is particularly useful to
2749 check for application bugs causing session crossing or stealing between
2750 users, because generally the user's cookies can only change on a login page.
2751
2752 When the cookie was not presented by the client, the associated log column
2753 will report "-". When a request does not cause a cookie to be assigned by the
2754 server, a "-" is reported in the response column.
2755
2756 The capture is performed in the frontend only because it is necessary that
2757 the log format does not change for a given frontend depending on the
2758 backends. This may change in the future. Note that there can be only one
Willy Tarreau193b8c62012-11-22 00:17:38 +01002759 "capture cookie" statement in a frontend. The maximum capture length is set
2760 by the global "tune.http.cookielen" setting and defaults to 63 characters. It
2761 is not possible to specify a capture in a "defaults" section.
Willy Tarreau0ba27502007-12-24 16:55:16 +01002762
2763 Example:
2764 capture cookie ASPSESSION len 32
2765
2766 See also : "capture request header", "capture response header" as well as
Willy Tarreauc57f0e22009-05-10 13:12:33 +02002767 section 8 about logging.
Willy Tarreau0ba27502007-12-24 16:55:16 +01002768
2769
2770capture request header <name> len <length>
Willy Tarreau4460d032012-11-21 23:37:37 +01002771 Capture and log the last occurrence of the specified request header.
Willy Tarreau0ba27502007-12-24 16:55:16 +01002772 May be used in sections : defaults | frontend | listen | backend
2773 no | yes | yes | no
2774 Arguments :
2775 <name> is the name of the header to capture. The header names are not
Willy Tarreaud2a4aa22008-01-31 15:28:22 +01002776 case-sensitive, but it is a common practice to write them as they
Willy Tarreau0ba27502007-12-24 16:55:16 +01002777 appear in the requests, with the first letter of each word in
2778 upper case. The header name will not appear in the logs, only the
2779 value is reported, but the position in the logs is respected.
2780
2781 <length> is the maximum number of characters to extract from the value and
2782 report in the logs. The string will be truncated on the right if
2783 it exceeds <length>.
2784
Willy Tarreau4460d032012-11-21 23:37:37 +01002785 The complete value of the last occurrence of the header is captured. The
Willy Tarreau0ba27502007-12-24 16:55:16 +01002786 value will be added to the logs between braces ('{}'). If multiple headers
2787 are captured, they will be delimited by a vertical bar ('|') and will appear
Willy Tarreaucc6c8912009-02-22 10:53:55 +01002788 in the same order they were declared in the configuration. Non-existent
2789 headers will be logged just as an empty string. Common uses for request
2790 header captures include the "Host" field in virtual hosting environments, the
2791 "Content-length" when uploads are supported, "User-agent" to quickly
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +01002792 differentiate between real users and robots, and "X-Forwarded-For" in proxied
Willy Tarreaucc6c8912009-02-22 10:53:55 +01002793 environments to find where the request came from.
2794
2795 Note that when capturing headers such as "User-agent", some spaces may be
2796 logged, making the log analysis more difficult. Thus be careful about what
2797 you log if you know your log parser is not smart enough to rely on the
2798 braces.
Willy Tarreau0ba27502007-12-24 16:55:16 +01002799
Willy Tarreau0900abb2012-11-22 00:21:46 +01002800 There is no limit to the number of captured request headers nor to their
2801 length, though it is wise to keep them low to limit memory usage per session.
2802 In order to keep log format consistent for a same frontend, header captures
2803 can only be declared in a frontend. It is not possible to specify a capture
2804 in a "defaults" section.
Willy Tarreau0ba27502007-12-24 16:55:16 +01002805
2806 Example:
2807 capture request header Host len 15
2808 capture request header X-Forwarded-For len 15
Cyril Bontéd1b0f7c2015-10-26 22:37:39 +01002809 capture request header Referer len 15
Willy Tarreau0ba27502007-12-24 16:55:16 +01002810
Willy Tarreauc57f0e22009-05-10 13:12:33 +02002811 See also : "capture cookie", "capture response header" as well as section 8
Willy Tarreau0ba27502007-12-24 16:55:16 +01002812 about logging.
2813
2814
2815capture response header <name> len <length>
Willy Tarreau4460d032012-11-21 23:37:37 +01002816 Capture and log the last occurrence of the specified response header.
Willy Tarreau0ba27502007-12-24 16:55:16 +01002817 May be used in sections : defaults | frontend | listen | backend
2818 no | yes | yes | no
2819 Arguments :
2820 <name> is the name of the header to capture. The header names are not
Willy Tarreaud2a4aa22008-01-31 15:28:22 +01002821 case-sensitive, but it is a common practice to write them as they
Willy Tarreau0ba27502007-12-24 16:55:16 +01002822 appear in the response, with the first letter of each word in
2823 upper case. The header name will not appear in the logs, only the
2824 value is reported, but the position in the logs is respected.
2825
2826 <length> is the maximum number of characters to extract from the value and
2827 report in the logs. The string will be truncated on the right if
2828 it exceeds <length>.
2829
Willy Tarreau4460d032012-11-21 23:37:37 +01002830 The complete value of the last occurrence of the header is captured. The
Willy Tarreau0ba27502007-12-24 16:55:16 +01002831 result will be added to the logs between braces ('{}') after the captured
2832 request headers. If multiple headers are captured, they will be delimited by
2833 a vertical bar ('|') and will appear in the same order they were declared in
Willy Tarreaucc6c8912009-02-22 10:53:55 +01002834 the configuration. Non-existent headers will be logged just as an empty
2835 string. Common uses for response header captures include the "Content-length"
2836 header which indicates how many bytes are expected to be returned, the
2837 "Location" header to track redirections.
Willy Tarreau0ba27502007-12-24 16:55:16 +01002838
Willy Tarreau0900abb2012-11-22 00:21:46 +01002839 There is no limit to the number of captured response headers nor to their
2840 length, though it is wise to keep them low to limit memory usage per session.
2841 In order to keep log format consistent for a same frontend, header captures
2842 can only be declared in a frontend. It is not possible to specify a capture
2843 in a "defaults" section.
Willy Tarreau0ba27502007-12-24 16:55:16 +01002844
2845 Example:
2846 capture response header Content-length len 9
2847 capture response header Location len 15
2848
Willy Tarreauc57f0e22009-05-10 13:12:33 +02002849 See also : "capture cookie", "capture request header" as well as section 8
Willy Tarreau0ba27502007-12-24 16:55:16 +01002850 about logging.
2851
2852
Cyril Bontéf0c60612010-02-06 14:44:47 +01002853clitimeout <timeout> (deprecated)
Willy Tarreau0ba27502007-12-24 16:55:16 +01002854 Set the maximum inactivity time on the client side.
2855 May be used in sections : defaults | frontend | listen | backend
2856 yes | yes | yes | no
2857 Arguments :
2858 <timeout> is the timeout value is specified in milliseconds by default, but
2859 can be in any other unit if the number is suffixed by the unit,
2860 as explained at the top of this document.
2861
2862 The inactivity timeout applies when the client is expected to acknowledge or
2863 send data. In HTTP mode, this timeout is particularly important to consider
2864 during the first phase, when the client sends the request, and during the
2865 response while it is reading data sent by the server. The value is specified
2866 in milliseconds by default, but can be in any other unit if the number is
2867 suffixed by the unit, as specified at the top of this document. In TCP mode
2868 (and to a lesser extent, in HTTP mode), it is highly recommended that the
2869 client timeout remains equal to the server timeout in order to avoid complex
Willy Tarreaud2a4aa22008-01-31 15:28:22 +01002870 situations to debug. It is a good practice to cover one or several TCP packet
Willy Tarreau0ba27502007-12-24 16:55:16 +01002871 losses by specifying timeouts that are slightly above multiples of 3 seconds
Davor Ocelice9ed2812017-12-25 17:49:28 +01002872 (e.g. 4 or 5 seconds).
Willy Tarreau0ba27502007-12-24 16:55:16 +01002873
2874 This parameter is specific to frontends, but can be specified once for all in
2875 "defaults" sections. This is in fact one of the easiest solutions not to
2876 forget about it. An unspecified timeout results in an infinite timeout, which
2877 is not recommended. Such a usage is accepted and works but reports a warning
2878 during startup because it may results in accumulation of expired sessions in
2879 the system if the system's timeouts are not configured either.
2880
2881 This parameter is provided for compatibility but is currently deprecated.
2882 Please use "timeout client" instead.
2883
Willy Tarreau036fae02008-01-06 13:24:40 +01002884 See also : "timeout client", "timeout http-request", "timeout server", and
2885 "srvtimeout".
Willy Tarreau0ba27502007-12-24 16:55:16 +01002886
Cyril Bonté316a8cf2012-11-11 13:38:27 +01002887compression algo <algorithm> ...
2888compression type <mime type> ...
Willy Tarreau70737d12012-10-27 00:34:28 +02002889compression offload
William Lallemand82fe75c2012-10-23 10:25:10 +02002890 Enable HTTP compression.
2891 May be used in sections : defaults | frontend | listen | backend
2892 yes | yes | yes | yes
2893 Arguments :
Cyril Bonté316a8cf2012-11-11 13:38:27 +01002894 algo is followed by the list of supported compression algorithms.
2895 type is followed by the list of MIME types that will be compressed.
2896 offload makes haproxy work as a compression offloader only (see notes).
2897
2898 The currently supported algorithms are :
Willy Tarreauc91840a2015-03-28 17:00:39 +01002899 identity this is mostly for debugging, and it was useful for developing
2900 the compression feature. Identity does not apply any change on
2901 data.
Cyril Bonté316a8cf2012-11-11 13:38:27 +01002902
Willy Tarreauc91840a2015-03-28 17:00:39 +01002903 gzip applies gzip compression. This setting is only available when
Baptiste Assmannf085d632015-12-21 17:57:32 +01002904 support for zlib or libslz was built in.
Willy Tarreauc91840a2015-03-28 17:00:39 +01002905
2906 deflate same as "gzip", but with deflate algorithm and zlib format.
2907 Note that this algorithm has ambiguous support on many
2908 browsers and no support at all from recent ones. It is
2909 strongly recommended not to use it for anything else than
2910 experimentation. This setting is only available when support
Baptiste Assmannf085d632015-12-21 17:57:32 +01002911 for zlib or libslz was built in.
Cyril Bonté316a8cf2012-11-11 13:38:27 +01002912
Willy Tarreauc91840a2015-03-28 17:00:39 +01002913 raw-deflate same as "deflate" without the zlib wrapper, and used as an
2914 alternative when the browser wants "deflate". All major
2915 browsers understand it and despite violating the standards,
2916 it is known to work better than "deflate", at least on MSIE
2917 and some versions of Safari. Do not use it in conjunction
2918 with "deflate", use either one or the other since both react
2919 to the same Accept-Encoding token. This setting is only
Baptiste Assmannf085d632015-12-21 17:57:32 +01002920 available when support for zlib or libslz was built in.
Cyril Bonté316a8cf2012-11-11 13:38:27 +01002921
Dmitry Sivachenko87c208b2012-11-22 20:03:26 +04002922 Compression will be activated depending on the Accept-Encoding request
Cyril Bonté316a8cf2012-11-11 13:38:27 +01002923 header. With identity, it does not take care of that header.
Dmitry Sivachenkoc9f3b452012-11-28 17:47:11 +04002924 If backend servers support HTTP compression, these directives
2925 will be no-op: haproxy will see the compressed response and will not
2926 compress again. If backend servers do not support HTTP compression and
2927 there is Accept-Encoding header in request, haproxy will compress the
2928 matching response.
Willy Tarreau70737d12012-10-27 00:34:28 +02002929
2930 The "offload" setting makes haproxy remove the Accept-Encoding header to
2931 prevent backend servers from compressing responses. It is strongly
2932 recommended not to do this because this means that all the compression work
2933 will be done on the single point where haproxy is located. However in some
2934 deployment scenarios, haproxy may be installed in front of a buggy gateway
Dmitry Sivachenkoc9f3b452012-11-28 17:47:11 +04002935 with broken HTTP compression implementation which can't be turned off.
2936 In that case haproxy can be used to prevent that gateway from emitting
2937 invalid payloads. In this case, simply removing the header in the
2938 configuration does not work because it applies before the header is parsed,
2939 so that prevents haproxy from compressing. The "offload" setting should
Willy Tarreauffea9fd2014-07-12 16:37:02 +02002940 then be used for such scenarios. Note: for now, the "offload" setting is
2941 ignored when set in a defaults section.
William Lallemand82fe75c2012-10-23 10:25:10 +02002942
William Lallemand05097442012-11-20 12:14:28 +01002943 Compression is disabled when:
Baptiste Assmann650d53d2013-01-05 15:44:44 +01002944 * the request does not advertise a supported compression algorithm in the
2945 "Accept-Encoding" header
2946 * the response message is not HTTP/1.1
William Lallemandd3002612012-11-26 14:34:47 +01002947 * HTTP status code is not 200
William Lallemand8bb4e342013-12-10 17:28:48 +01002948 * response header "Transfer-Encoding" contains "chunked" (Temporary
2949 Workaround)
Baptiste Assmann650d53d2013-01-05 15:44:44 +01002950 * response contain neither a "Content-Length" header nor a
2951 "Transfer-Encoding" whose last value is "chunked"
2952 * response contains a "Content-Type" header whose first value starts with
2953 "multipart"
2954 * the response contains the "no-transform" value in the "Cache-control"
2955 header
2956 * User-Agent matches "Mozilla/4" unless it is MSIE 6 with XP SP2, or MSIE 7
2957 and later
2958 * The response contains a "Content-Encoding" header, indicating that the
2959 response is already compressed (see compression offload)
William Lallemand05097442012-11-20 12:14:28 +01002960
Baptiste Assmann650d53d2013-01-05 15:44:44 +01002961 Note: The compression does not rewrite Etag headers, and does not emit the
2962 Warning header.
William Lallemand05097442012-11-20 12:14:28 +01002963
William Lallemand82fe75c2012-10-23 10:25:10 +02002964 Examples :
2965 compression algo gzip
2966 compression type text/html text/plain
Willy Tarreau0ba27502007-12-24 16:55:16 +01002967
Christopher Fauletc3fe5332016-04-07 15:30:10 +02002968
Cyril Bontéf0c60612010-02-06 14:44:47 +01002969contimeout <timeout> (deprecated)
Willy Tarreau0ba27502007-12-24 16:55:16 +01002970 Set the maximum time to wait for a connection attempt to a server to succeed.
2971 May be used in sections : defaults | frontend | listen | backend
2972 yes | no | yes | yes
2973 Arguments :
2974 <timeout> is the timeout value is specified in milliseconds by default, but
2975 can be in any other unit if the number is suffixed by the unit,
2976 as explained at the top of this document.
2977
2978 If the server is located on the same LAN as haproxy, the connection should be
Willy Tarreaud2a4aa22008-01-31 15:28:22 +01002979 immediate (less than a few milliseconds). Anyway, it is a good practice to
Willy Tarreaud72758d2010-01-12 10:42:19 +01002980 cover one or several TCP packet losses by specifying timeouts that are
Davor Ocelice9ed2812017-12-25 17:49:28 +01002981 slightly above multiples of 3 seconds (e.g. 4 or 5 seconds). By default, the
Willy Tarreau0ba27502007-12-24 16:55:16 +01002982 connect timeout also presets the queue timeout to the same value if this one
2983 has not been specified. Historically, the contimeout was also used to set the
2984 tarpit timeout in a listen section, which is not possible in a pure frontend.
2985
2986 This parameter is specific to backends, but can be specified once for all in
2987 "defaults" sections. This is in fact one of the easiest solutions not to
2988 forget about it. An unspecified timeout results in an infinite timeout, which
2989 is not recommended. Such a usage is accepted and works but reports a warning
2990 during startup because it may results in accumulation of failed sessions in
2991 the system if the system's timeouts are not configured either.
2992
2993 This parameter is provided for backwards compatibility but is currently
2994 deprecated. Please use "timeout connect", "timeout queue" or "timeout tarpit"
2995 instead.
2996
2997 See also : "timeout connect", "timeout queue", "timeout tarpit",
2998 "timeout server", "contimeout".
2999
3000
Willy Tarreau55165fe2009-05-10 12:02:55 +02003001cookie <name> [ rewrite | insert | prefix ] [ indirect ] [ nocache ]
Willy Tarreau4992dd22012-05-31 21:02:17 +02003002 [ postonly ] [ preserve ] [ httponly ] [ secure ]
3003 [ domain <domain> ]* [ maxidle <idle> ] [ maxlife <life> ]
Olivier Houchard4e694042017-03-14 20:01:29 +01003004 [ dynamic ]
Willy Tarreau0ba27502007-12-24 16:55:16 +01003005 Enable cookie-based persistence in a backend.
3006 May be used in sections : defaults | frontend | listen | backend
3007 yes | no | yes | yes
3008 Arguments :
3009 <name> is the name of the cookie which will be monitored, modified or
3010 inserted in order to bring persistence. This cookie is sent to
3011 the client via a "Set-Cookie" header in the response, and is
3012 brought back by the client in a "Cookie" header in all requests.
3013 Special care should be taken to choose a name which does not
3014 conflict with any likely application cookie. Also, if the same
Davor Ocelice9ed2812017-12-25 17:49:28 +01003015 backends are subject to be used by the same clients (e.g.
Willy Tarreau0ba27502007-12-24 16:55:16 +01003016 HTTP/HTTPS), care should be taken to use different cookie names
3017 between all backends if persistence between them is not desired.
3018
3019 rewrite This keyword indicates that the cookie will be provided by the
3020 server and that haproxy will have to modify its value to set the
3021 server's identifier in it. This mode is handy when the management
3022 of complex combinations of "Set-cookie" and "Cache-control"
3023 headers is left to the application. The application can then
3024 decide whether or not it is appropriate to emit a persistence
Lukas Tribusf01a9cd2016-02-03 18:09:37 +01003025 cookie. Since all responses should be monitored, this mode
3026 doesn't work in HTTP tunnel mode. Unless the application
Davor Ocelice9ed2812017-12-25 17:49:28 +01003027 behavior is very complex and/or broken, it is advised not to
Lukas Tribusf01a9cd2016-02-03 18:09:37 +01003028 start with this mode for new deployments. This keyword is
3029 incompatible with "insert" and "prefix".
Willy Tarreau0ba27502007-12-24 16:55:16 +01003030
3031 insert This keyword indicates that the persistence cookie will have to
Willy Tarreaua79094d2010-08-31 22:54:15 +02003032 be inserted by haproxy in server responses if the client did not
Willy Tarreauba4c5be2010-10-23 12:46:42 +02003033
Willy Tarreaua79094d2010-08-31 22:54:15 +02003034 already have a cookie that would have permitted it to access this
Willy Tarreauba4c5be2010-10-23 12:46:42 +02003035 server. When used without the "preserve" option, if the server
3036 emits a cookie with the same name, it will be remove before
Davor Ocelice9ed2812017-12-25 17:49:28 +01003037 processing. For this reason, this mode can be used to upgrade
Willy Tarreauba4c5be2010-10-23 12:46:42 +02003038 existing configurations running in the "rewrite" mode. The cookie
3039 will only be a session cookie and will not be stored on the
3040 client's disk. By default, unless the "indirect" option is added,
3041 the server will see the cookies emitted by the client. Due to
3042 caching effects, it is generally wise to add the "nocache" or
3043 "postonly" keywords (see below). The "insert" keyword is not
3044 compatible with "rewrite" and "prefix".
Willy Tarreau0ba27502007-12-24 16:55:16 +01003045
3046 prefix This keyword indicates that instead of relying on a dedicated
3047 cookie for the persistence, an existing one will be completed.
3048 This may be needed in some specific environments where the client
3049 does not support more than one single cookie and the application
3050 already needs it. In this case, whenever the server sets a cookie
3051 named <name>, it will be prefixed with the server's identifier
3052 and a delimiter. The prefix will be removed from all client
3053 requests so that the server still finds the cookie it emitted.
3054 Since all requests and responses are subject to being modified,
Lukas Tribusf01a9cd2016-02-03 18:09:37 +01003055 this mode doesn't work with tunnel mode. The "prefix" keyword is
Willy Tarreau37229df2011-10-17 12:24:55 +02003056 not compatible with "rewrite" and "insert". Note: it is highly
3057 recommended not to use "indirect" with "prefix", otherwise server
3058 cookie updates would not be sent to clients.
Willy Tarreau0ba27502007-12-24 16:55:16 +01003059
Willy Tarreaua79094d2010-08-31 22:54:15 +02003060 indirect When this option is specified, no cookie will be emitted to a
3061 client which already has a valid one for the server which has
3062 processed the request. If the server sets such a cookie itself,
Willy Tarreauba4c5be2010-10-23 12:46:42 +02003063 it will be removed, unless the "preserve" option is also set. In
3064 "insert" mode, this will additionally remove cookies from the
3065 requests transmitted to the server, making the persistence
3066 mechanism totally transparent from an application point of view.
Willy Tarreau37229df2011-10-17 12:24:55 +02003067 Note: it is highly recommended not to use "indirect" with
3068 "prefix", otherwise server cookie updates would not be sent to
3069 clients.
Willy Tarreau0ba27502007-12-24 16:55:16 +01003070
3071 nocache This option is recommended in conjunction with the insert mode
3072 when there is a cache between the client and HAProxy, as it
3073 ensures that a cacheable response will be tagged non-cacheable if
3074 a cookie needs to be inserted. This is important because if all
3075 persistence cookies are added on a cacheable home page for
3076 instance, then all customers will then fetch the page from an
3077 outer cache and will all share the same persistence cookie,
3078 leading to one server receiving much more traffic than others.
3079 See also the "insert" and "postonly" options.
3080
3081 postonly This option ensures that cookie insertion will only be performed
3082 on responses to POST requests. It is an alternative to the
3083 "nocache" option, because POST responses are not cacheable, so
3084 this ensures that the persistence cookie will never get cached.
3085 Since most sites do not need any sort of persistence before the
3086 first POST which generally is a login request, this is a very
3087 efficient method to optimize caching without risking to find a
3088 persistence cookie in the cache.
3089 See also the "insert" and "nocache" options.
3090
Willy Tarreauba4c5be2010-10-23 12:46:42 +02003091 preserve This option may only be used with "insert" and/or "indirect". It
3092 allows the server to emit the persistence cookie itself. In this
3093 case, if a cookie is found in the response, haproxy will leave it
3094 untouched. This is useful in order to end persistence after a
3095 logout request for instance. For this, the server just has to
Davor Ocelice9ed2812017-12-25 17:49:28 +01003096 emit a cookie with an invalid value (e.g. empty) or with a date in
Willy Tarreauba4c5be2010-10-23 12:46:42 +02003097 the past. By combining this mechanism with the "disable-on-404"
3098 check option, it is possible to perform a completely graceful
3099 shutdown because users will definitely leave the server after
3100 they logout.
3101
Willy Tarreau4992dd22012-05-31 21:02:17 +02003102 httponly This option tells haproxy to add an "HttpOnly" cookie attribute
3103 when a cookie is inserted. This attribute is used so that a
3104 user agent doesn't share the cookie with non-HTTP components.
3105 Please check RFC6265 for more information on this attribute.
3106
3107 secure This option tells haproxy to add a "Secure" cookie attribute when
3108 a cookie is inserted. This attribute is used so that a user agent
3109 never emits this cookie over non-secure channels, which means
3110 that a cookie learned with this flag will be presented only over
3111 SSL/TLS connections. Please check RFC6265 for more information on
3112 this attribute.
3113
Krzysztof Piotr Oledzkiefe3b6f2008-05-23 23:49:32 +02003114 domain This option allows to specify the domain at which a cookie is
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +01003115 inserted. It requires exactly one parameter: a valid domain
Willy Tarreau68a897b2009-12-03 23:28:34 +01003116 name. If the domain begins with a dot, the browser is allowed to
3117 use it for any host ending with that name. It is also possible to
3118 specify several domain names by invoking this option multiple
3119 times. Some browsers might have small limits on the number of
3120 domains, so be careful when doing that. For the record, sending
3121 10 domains to MSIE 6 or Firefox 2 works as expected.
Krzysztof Piotr Oledzkiefe3b6f2008-05-23 23:49:32 +02003122
Willy Tarreau996a92c2010-10-13 19:30:47 +02003123 maxidle This option allows inserted cookies to be ignored after some idle
3124 time. It only works with insert-mode cookies. When a cookie is
3125 sent to the client, the date this cookie was emitted is sent too.
3126 Upon further presentations of this cookie, if the date is older
3127 than the delay indicated by the parameter (in seconds), it will
3128 be ignored. Otherwise, it will be refreshed if needed when the
3129 response is sent to the client. This is particularly useful to
3130 prevent users who never close their browsers from remaining for
Davor Ocelice9ed2812017-12-25 17:49:28 +01003131 too long on the same server (e.g. after a farm size change). When
Willy Tarreau996a92c2010-10-13 19:30:47 +02003132 this option is set and a cookie has no date, it is always
3133 accepted, but gets refreshed in the response. This maintains the
3134 ability for admins to access their sites. Cookies that have a
3135 date in the future further than 24 hours are ignored. Doing so
3136 lets admins fix timezone issues without risking kicking users off
3137 the site.
3138
3139 maxlife This option allows inserted cookies to be ignored after some life
3140 time, whether they're in use or not. It only works with insert
3141 mode cookies. When a cookie is first sent to the client, the date
3142 this cookie was emitted is sent too. Upon further presentations
3143 of this cookie, if the date is older than the delay indicated by
3144 the parameter (in seconds), it will be ignored. If the cookie in
3145 the request has no date, it is accepted and a date will be set.
3146 Cookies that have a date in the future further than 24 hours are
3147 ignored. Doing so lets admins fix timezone issues without risking
3148 kicking users off the site. Contrary to maxidle, this value is
3149 not refreshed, only the first visit date counts. Both maxidle and
3150 maxlife may be used at the time. This is particularly useful to
3151 prevent users who never close their browsers from remaining for
Davor Ocelice9ed2812017-12-25 17:49:28 +01003152 too long on the same server (e.g. after a farm size change). This
Willy Tarreau996a92c2010-10-13 19:30:47 +02003153 is stronger than the maxidle method in that it forces a
3154 redispatch after some absolute delay.
3155
Olivier Houchard4e694042017-03-14 20:01:29 +01003156 dynamic Activate dynamic cookies. When used, a session cookie is
3157 dynamically created for each server, based on the IP and port
3158 of the server, and a secret key, specified in the
3159 "dynamic-cookie-key" backend directive.
3160 The cookie will be regenerated each time the IP address change,
3161 and is only generated for IPv4/IPv6.
3162
Willy Tarreau0ba27502007-12-24 16:55:16 +01003163 There can be only one persistence cookie per HTTP backend, and it can be
3164 declared in a defaults section. The value of the cookie will be the value
3165 indicated after the "cookie" keyword in a "server" statement. If no cookie
3166 is declared for a given server, the cookie is not set.
Willy Tarreau6a06a402007-07-15 20:15:28 +02003167
Willy Tarreau0ba27502007-12-24 16:55:16 +01003168 Examples :
3169 cookie JSESSIONID prefix
3170 cookie SRV insert indirect nocache
3171 cookie SRV insert postonly indirect
Willy Tarreau996a92c2010-10-13 19:30:47 +02003172 cookie SRV insert indirect nocache maxidle 30m maxlife 8h
Willy Tarreau0ba27502007-12-24 16:55:16 +01003173
Willy Tarreau294d0f02015-08-10 19:40:12 +02003174 See also : "balance source", "capture cookie", "server" and "ignore-persist".
Willy Tarreau0ba27502007-12-24 16:55:16 +01003175
Willy Tarreau983e01e2010-01-11 18:42:06 +01003176
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +02003177declare capture [ request | response ] len <length>
3178 Declares a capture slot.
3179 May be used in sections : defaults | frontend | listen | backend
3180 no | yes | yes | no
3181 Arguments:
3182 <length> is the length allowed for the capture.
3183
3184 This declaration is only available in the frontend or listen section, but the
3185 reserved slot can be used in the backends. The "request" keyword allocates a
3186 capture slot for use in the request, and "response" allocates a capture slot
3187 for use in the response.
3188
3189 See also: "capture-req", "capture-res" (sample converters),
Baptiste Assmann5ac425c2015-10-21 23:13:46 +02003190 "capture.req.hdr", "capture.res.hdr" (sample fetches),
Thierry FOURNIERa0a1b752015-05-26 17:44:32 +02003191 "http-request capture" and "http-response capture".
3192
3193
Krzysztof Piotr Oledzkic6df0662010-01-05 16:38:49 +01003194default-server [param*]
3195 Change default options for a server in a backend
3196 May be used in sections : defaults | frontend | listen | backend
3197 yes | no | yes | yes
3198 Arguments:
Willy Tarreau983e01e2010-01-11 18:42:06 +01003199 <param*> is a list of parameters for this server. The "default-server"
3200 keyword accepts an important number of options and has a complete
3201 section dedicated to it. Please refer to section 5 for more
3202 details.
Krzysztof Piotr Oledzkic6df0662010-01-05 16:38:49 +01003203
Willy Tarreau983e01e2010-01-11 18:42:06 +01003204 Example :
Krzysztof Piotr Oledzkic6df0662010-01-05 16:38:49 +01003205 default-server inter 1000 weight 13
3206
3207 See also: "server" and section 5 about server options
Willy Tarreau0ba27502007-12-24 16:55:16 +01003208
Willy Tarreau983e01e2010-01-11 18:42:06 +01003209
Willy Tarreau0ba27502007-12-24 16:55:16 +01003210default_backend <backend>
3211 Specify the backend to use when no "use_backend" rule has been matched.
3212 May be used in sections : defaults | frontend | listen | backend
3213 yes | yes | yes | no
3214 Arguments :
3215 <backend> is the name of the backend to use.
3216
3217 When doing content-switching between frontend and backends using the
3218 "use_backend" keyword, it is often useful to indicate which backend will be
3219 used when no rule has matched. It generally is the dynamic backend which
3220 will catch all undetermined requests.
3221
Willy Tarreau0ba27502007-12-24 16:55:16 +01003222 Example :
3223
3224 use_backend dynamic if url_dyn
3225 use_backend static if url_css url_img extension_img
3226 default_backend dynamic
3227
Willy Tarreau98d04852015-05-26 12:18:29 +02003228 See also : "use_backend"
Willy Tarreau2769aa02007-12-27 18:26:09 +01003229
Willy Tarreau0ba27502007-12-24 16:55:16 +01003230
Baptiste Assmann27f51342013-10-09 06:51:49 +02003231description <string>
3232 Describe a listen, frontend or backend.
3233 May be used in sections : defaults | frontend | listen | backend
3234 no | yes | yes | yes
3235 Arguments : string
3236
3237 Allows to add a sentence to describe the related object in the HAProxy HTML
3238 stats page. The description will be printed on the right of the object name
3239 it describes.
3240 No need to backslash spaces in the <string> arguments.
3241
3242
Willy Tarreau0ba27502007-12-24 16:55:16 +01003243disabled
3244 Disable a proxy, frontend or backend.
3245 May be used in sections : defaults | frontend | listen | backend
3246 yes | yes | yes | yes
3247 Arguments : none
3248
3249 The "disabled" keyword is used to disable an instance, mainly in order to
3250 liberate a listening port or to temporarily disable a service. The instance
3251 will still be created and its configuration will be checked, but it will be
3252 created in the "stopped" state and will appear as such in the statistics. It
3253 will not receive any traffic nor will it send any health-checks or logs. It
3254 is possible to disable many instances at once by adding the "disabled"
3255 keyword in a "defaults" section.
3256
3257 See also : "enabled"
3258
3259
Willy Tarreau5ce94572010-06-07 14:35:41 +02003260dispatch <address>:<port>
3261 Set a default server address
3262 May be used in sections : defaults | frontend | listen | backend
3263 no | no | yes | yes
Cyril Bonté108cf6e2012-04-21 23:30:29 +02003264 Arguments :
Willy Tarreau5ce94572010-06-07 14:35:41 +02003265
3266 <address> is the IPv4 address of the default server. Alternatively, a
3267 resolvable hostname is supported, but this name will be resolved
3268 during start-up.
3269
3270 <ports> is a mandatory port specification. All connections will be sent
3271 to this port, and it is not permitted to use port offsets as is
3272 possible with normal servers.
3273
Willy Tarreau787aed52011-04-15 06:45:37 +02003274 The "dispatch" keyword designates a default server for use when no other
Willy Tarreau5ce94572010-06-07 14:35:41 +02003275 server can take the connection. In the past it was used to forward non
3276 persistent connections to an auxiliary load balancer. Due to its simple
3277 syntax, it has also been used for simple TCP relays. It is recommended not to
3278 use it for more clarity, and to use the "server" directive instead.
3279
3280 See also : "server"
3281
Olivier Houchard4e694042017-03-14 20:01:29 +01003282
3283dynamic-cookie-key <string>
3284 Set the dynamic cookie secret key for a backend.
3285 May be used in sections : defaults | frontend | listen | backend
3286 yes | no | yes | yes
3287 Arguments : The secret key to be used.
3288
3289 When dynamic cookies are enabled (see the "dynamic" directive for cookie),
Davor Ocelice9ed2812017-12-25 17:49:28 +01003290 a dynamic cookie is created for each server (unless one is explicitly
Olivier Houchard4e694042017-03-14 20:01:29 +01003291 specified on the "server" line), using a hash of the IP address of the
3292 server, the TCP port, and the secret key.
Davor Ocelice9ed2812017-12-25 17:49:28 +01003293 That way, we can ensure session persistence across multiple load-balancers,
Olivier Houchard4e694042017-03-14 20:01:29 +01003294 even if servers are dynamically added or removed.
Willy Tarreau5ce94572010-06-07 14:35:41 +02003295
Willy Tarreau0ba27502007-12-24 16:55:16 +01003296enabled
3297 Enable a proxy, frontend or backend.
3298 May be used in sections : defaults | frontend | listen | backend
3299 yes | yes | yes | yes
3300 Arguments : none
3301
3302 The "enabled" keyword is used to explicitly enable an instance, when the
3303 defaults has been set to "disabled". This is very rarely used.
3304
3305 See also : "disabled"
3306
3307
3308errorfile <code> <file>
3309 Return a file contents instead of errors generated by HAProxy
3310 May be used in sections : defaults | frontend | listen | backend
3311 yes | yes | yes | yes
3312 Arguments :
3313 <code> is the HTTP status code. Currently, HAProxy is capable of
Olivier Houchard51a76d82017-10-02 16:12:07 +02003314 generating codes 200, 400, 403, 405, 408, 425, 429, 500, 502,
3315 503, and 504.
Willy Tarreau0ba27502007-12-24 16:55:16 +01003316
3317 <file> designates a file containing the full HTTP response. It is
Willy Tarreaud2a4aa22008-01-31 15:28:22 +01003318 recommended to follow the common practice of appending ".http" to
Willy Tarreau0ba27502007-12-24 16:55:16 +01003319 the filename so that people do not confuse the response with HTML
Willy Tarreau59140a22009-02-22 12:02:30 +01003320 error pages, and to use absolute paths, since files are read
3321 before any chroot is performed.
Willy Tarreau0ba27502007-12-24 16:55:16 +01003322
3323 It is important to understand that this keyword is not meant to rewrite
3324 errors returned by the server, but errors detected and returned by HAProxy.
3325 This is why the list of supported errors is limited to a small set.
3326
Willy Tarreauae94d4d2011-05-11 16:28:49 +02003327 Code 200 is emitted in response to requests matching a "monitor-uri" rule.
3328
Willy Tarreau0ba27502007-12-24 16:55:16 +01003329 The files are returned verbatim on the TCP socket. This allows any trick such
3330 as redirections to another URL or site, as well as tricks to clean cookies,
3331 force enable or disable caching, etc... The package provides default error
3332 files returning the same contents as default errors.
3333
Willy Tarreau59140a22009-02-22 12:02:30 +01003334 The files should not exceed the configured buffer size (BUFSIZE), which
3335 generally is 8 or 16 kB, otherwise they will be truncated. It is also wise
Davor Ocelice9ed2812017-12-25 17:49:28 +01003336 not to put any reference to local contents (e.g. images) in order to avoid
Willy Tarreau59140a22009-02-22 12:02:30 +01003337 loops between the client and HAProxy when all servers are down, causing an
3338 error to be returned instead of an image. For better HTTP compliance, it is
3339 recommended that all header lines end with CR-LF and not LF alone.
3340
Willy Tarreau0ba27502007-12-24 16:55:16 +01003341 The files are read at the same time as the configuration and kept in memory.
3342 For this reason, the errors continue to be returned even when the process is
3343 chrooted, and no file change is considered while the process is running. A
Willy Tarreauc27debf2008-01-06 08:57:02 +01003344 simple method for developing those files consists in associating them to the
Willy Tarreau0ba27502007-12-24 16:55:16 +01003345 403 status code and interrogating a blocked URL.
3346
3347 See also : "errorloc", "errorloc302", "errorloc303"
3348
Willy Tarreau59140a22009-02-22 12:02:30 +01003349 Example :
3350 errorfile 400 /etc/haproxy/errorfiles/400badreq.http
Willy Tarreau989222a2016-01-15 10:26:26 +01003351 errorfile 408 /dev/null # work around Chrome pre-connect bug
Willy Tarreau59140a22009-02-22 12:02:30 +01003352 errorfile 403 /etc/haproxy/errorfiles/403forbid.http
3353 errorfile 503 /etc/haproxy/errorfiles/503sorry.http
3354
Willy Tarreau2769aa02007-12-27 18:26:09 +01003355
3356errorloc <code> <url>
3357errorloc302 <code> <url>
3358 Return an HTTP redirection to a URL instead of errors generated by HAProxy
3359 May be used in sections : defaults | frontend | listen | backend
3360 yes | yes | yes | yes
3361 Arguments :
3362 <code> is the HTTP status code. Currently, HAProxy is capable of
Olivier Houchard51a76d82017-10-02 16:12:07 +02003363 generating codes 200, 400, 403, 405, 408, 425, 429, 500, 502,
3364 503, and 504.
Willy Tarreau2769aa02007-12-27 18:26:09 +01003365
3366 <url> it is the exact contents of the "Location" header. It may contain
3367 either a relative URI to an error page hosted on the same site,
3368 or an absolute URI designating an error page on another site.
3369 Special care should be given to relative URIs to avoid redirect
Davor Ocelice9ed2812017-12-25 17:49:28 +01003370 loops if the URI itself may generate the same error (e.g. 500).
Willy Tarreau2769aa02007-12-27 18:26:09 +01003371
3372 It is important to understand that this keyword is not meant to rewrite
3373 errors returned by the server, but errors detected and returned by HAProxy.
3374 This is why the list of supported errors is limited to a small set.
3375
Willy Tarreauae94d4d2011-05-11 16:28:49 +02003376 Code 200 is emitted in response to requests matching a "monitor-uri" rule.
3377
Willy Tarreau2769aa02007-12-27 18:26:09 +01003378 Note that both keyword return the HTTP 302 status code, which tells the
3379 client to fetch the designated URL using the same HTTP method. This can be
3380 quite problematic in case of non-GET methods such as POST, because the URL
3381 sent to the client might not be allowed for something other than GET. To
Willy Tarreau989222a2016-01-15 10:26:26 +01003382 work around this problem, please use "errorloc303" which send the HTTP 303
Willy Tarreau2769aa02007-12-27 18:26:09 +01003383 status code, indicating to the client that the URL must be fetched with a GET
3384 request.
3385
3386 See also : "errorfile", "errorloc303"
3387
3388
3389errorloc303 <code> <url>
3390 Return an HTTP redirection to a URL instead of errors generated by HAProxy
3391 May be used in sections : defaults | frontend | listen | backend
3392 yes | yes | yes | yes
3393 Arguments :
3394 <code> is the HTTP status code. Currently, HAProxy is capable of
Olivier Houchard51a76d82017-10-02 16:12:07 +02003395 generating codes 200, 400, 403, 405, 408, 425, 429, 500, 502,
3396 503, and 504.
Willy Tarreau2769aa02007-12-27 18:26:09 +01003397
3398 <url> it is the exact contents of the "Location" header. It may contain
3399 either a relative URI to an error page hosted on the same site,
3400 or an absolute URI designating an error page on another site.
3401 Special care should be given to relative URIs to avoid redirect
Davor Ocelice9ed2812017-12-25 17:49:28 +01003402 loops if the URI itself may generate the same error (e.g. 500).
Willy Tarreau2769aa02007-12-27 18:26:09 +01003403
3404 It is important to understand that this keyword is not meant to rewrite
3405 errors returned by the server, but errors detected and returned by HAProxy.
3406 This is why the list of supported errors is limited to a small set.
3407
Willy Tarreauae94d4d2011-05-11 16:28:49 +02003408 Code 200 is emitted in response to requests matching a "monitor-uri" rule.
3409
Willy Tarreau2769aa02007-12-27 18:26:09 +01003410 Note that both keyword return the HTTP 303 status code, which tells the
3411 client to fetch the designated URL using the same HTTP GET method. This
3412 solves the usual problems associated with "errorloc" and the 302 code. It is
3413 possible that some very old browsers designed before HTTP/1.1 do not support
Willy Tarreaud2a4aa22008-01-31 15:28:22 +01003414 it, but no such problem has been reported till now.
Willy Tarreau2769aa02007-12-27 18:26:09 +01003415
3416 See also : "errorfile", "errorloc", "errorloc302"
3417
3418
Simon Horman51a1cf62015-02-03 13:00:44 +09003419email-alert from <emailaddr>
3420 Declare the from email address to be used in both the envelope and header
Davor Ocelice9ed2812017-12-25 17:49:28 +01003421 of email alerts. This is the address that email alerts are sent from.
Simon Horman51a1cf62015-02-03 13:00:44 +09003422 May be used in sections: defaults | frontend | listen | backend
3423 yes | yes | yes | yes
3424
3425 Arguments :
3426
3427 <emailaddr> is the from email address to use when sending email alerts
3428
3429 Also requires "email-alert mailers" and "email-alert to" to be set
3430 and if so sending email alerts is enabled for the proxy.
3431
Simon Horman64e34162015-02-06 11:11:57 +09003432 See also : "email-alert level", "email-alert mailers",
Cyril Bonté307ee1e2015-09-28 23:16:06 +02003433 "email-alert myhostname", "email-alert to", section 3.6 about
3434 mailers.
Simon Horman64e34162015-02-06 11:11:57 +09003435
3436
3437email-alert level <level>
3438 Declare the maximum log level of messages for which email alerts will be
3439 sent. This acts as a filter on the sending of email alerts.
3440 May be used in sections: defaults | frontend | listen | backend
3441 yes | yes | yes | yes
3442
3443 Arguments :
3444
3445 <level> One of the 8 syslog levels:
3446 emerg alert crit err warning notice info debug
3447 The above syslog levels are ordered from lowest to highest.
3448
3449 By default level is alert
3450
3451 Also requires "email-alert from", "email-alert mailers" and
3452 "email-alert to" to be set and if so sending email alerts is enabled
3453 for the proxy.
3454
Simon Horman1421e212015-04-30 13:10:35 +09003455 Alerts are sent when :
3456
3457 * An un-paused server is marked as down and <level> is alert or lower
3458 * A paused server is marked as down and <level> is notice or lower
3459 * A server is marked as up or enters the drain state and <level>
3460 is notice or lower
3461 * "option log-health-checks" is enabled, <level> is info or lower,
3462 and a health check status update occurs
3463
Simon Horman64e34162015-02-06 11:11:57 +09003464 See also : "email-alert from", "email-alert mailers",
3465 "email-alert myhostname", "email-alert to",
Simon Horman51a1cf62015-02-03 13:00:44 +09003466 section 3.6 about mailers.
3467
3468
3469email-alert mailers <mailersect>
3470 Declare the mailers to be used when sending email alerts
3471 May be used in sections: defaults | frontend | listen | backend
3472 yes | yes | yes | yes
3473
3474 Arguments :
3475
3476 <mailersect> is the name of the mailers section to send email alerts.
3477
3478 Also requires "email-alert from" and "email-alert to" to be set
3479 and if so sending email alerts is enabled for the proxy.
3480
Simon Horman64e34162015-02-06 11:11:57 +09003481 See also : "email-alert from", "email-alert level", "email-alert myhostname",
3482 "email-alert to", section 3.6 about mailers.
Simon Horman51a1cf62015-02-03 13:00:44 +09003483
3484
3485email-alert myhostname <hostname>
3486 Declare the to hostname address to be used when communicating with
3487 mailers.
3488 May be used in sections: defaults | frontend | listen | backend
3489 yes | yes | yes | yes
3490
3491 Arguments :
3492
Baptiste Assmann738bad92015-12-21 15:27:53 +01003493 <hostname> is the hostname to use when communicating with mailers
Simon Horman51a1cf62015-02-03 13:00:44 +09003494
3495 By default the systems hostname is used.
3496
3497 Also requires "email-alert from", "email-alert mailers" and
3498 "email-alert to" to be set and if so sending email alerts is enabled
3499 for the proxy.
3500
Simon Horman64e34162015-02-06 11:11:57 +09003501 See also : "email-alert from", "email-alert level", "email-alert mailers",
3502 "email-alert to", section 3.6 about mailers.
Simon Horman51a1cf62015-02-03 13:00:44 +09003503
3504
3505email-alert to <emailaddr>
Davor Ocelice9ed2812017-12-25 17:49:28 +01003506 Declare both the recipient address in the envelope and to address in the
Simon Horman51a1cf62015-02-03 13:00:44 +09003507 header of email alerts. This is the address that email alerts are sent to.
3508 May be used in sections: defaults | frontend | listen | backend
3509 yes | yes | yes | yes
3510
3511 Arguments :
3512
3513 <emailaddr> is the to email address to use when sending email alerts
3514
3515 Also requires "email-alert mailers" and "email-alert to" to be set
3516 and if so sending email alerts is enabled for the proxy.
3517
Simon Horman64e34162015-02-06 11:11:57 +09003518 See also : "email-alert from", "email-alert level", "email-alert mailers",
Simon Horman51a1cf62015-02-03 13:00:44 +09003519 "email-alert myhostname", section 3.6 about mailers.
3520
3521
Willy Tarreau4de91492010-01-22 19:10:05 +01003522force-persist { if | unless } <condition>
3523 Declare a condition to force persistence on down servers
3524 May be used in sections: defaults | frontend | listen | backend
Cyril Bonté4288c5a2018-03-12 22:02:59 +01003525 no | no | yes | yes
Willy Tarreau4de91492010-01-22 19:10:05 +01003526
3527 By default, requests are not dispatched to down servers. It is possible to
3528 force this using "option persist", but it is unconditional and redispatches
3529 to a valid server if "option redispatch" is set. That leaves with very little
3530 possibilities to force some requests to reach a server which is artificially
3531 marked down for maintenance operations.
3532
3533 The "force-persist" statement allows one to declare various ACL-based
3534 conditions which, when met, will cause a request to ignore the down status of
3535 a server and still try to connect to it. That makes it possible to start a
3536 server, still replying an error to the health checks, and run a specially
3537 configured browser to test the service. Among the handy methods, one could
3538 use a specific source IP address, or a specific cookie. The cookie also has
3539 the advantage that it can easily be added/removed on the browser from a test
3540 page. Once the service is validated, it is then possible to open the service
3541 to the world by returning a valid response to health checks.
3542
3543 The forced persistence is enabled when an "if" condition is met, or unless an
3544 "unless" condition is met. The final redispatch is always disabled when this
3545 is used.
3546
Cyril Bonté0d4bf012010-04-25 23:21:46 +02003547 See also : "option redispatch", "ignore-persist", "persist",
Cyril Bontéa8e7bbc2010-04-25 22:29:29 +02003548 and section 7 about ACL usage.
Willy Tarreau4de91492010-01-22 19:10:05 +01003549
Christopher Fauletc3fe5332016-04-07 15:30:10 +02003550
3551filter <name> [param*]
3552 Add the filter <name> in the filter list attached to the proxy.
3553 May be used in sections : defaults | frontend | listen | backend
3554 no | yes | yes | yes
3555 Arguments :
3556 <name> is the name of the filter. Officially supported filters are
3557 referenced in section 9.
3558
Tim Düsterhus4896c442016-11-29 02:15:19 +01003559 <param*> is a list of parameters accepted by the filter <name>. The
Christopher Fauletc3fe5332016-04-07 15:30:10 +02003560 parsing of these parameters are the responsibility of the
Tim Düsterhus4896c442016-11-29 02:15:19 +01003561 filter. Please refer to the documentation of the corresponding
3562 filter (section 9) for all details on the supported parameters.
Christopher Fauletc3fe5332016-04-07 15:30:10 +02003563
3564 Multiple occurrences of the filter line can be used for the same proxy. The
3565 same filter can be referenced many times if needed.
3566
3567 Example:
3568 listen
3569 bind *:80
3570
3571 filter trace name BEFORE-HTTP-COMP
3572 filter compression
3573 filter trace name AFTER-HTTP-COMP
3574
3575 compression algo gzip
3576 compression offload
3577
3578 server srv1 192.168.0.1:80
3579
3580 See also : section 9.
3581
Willy Tarreau4de91492010-01-22 19:10:05 +01003582
Willy Tarreau2769aa02007-12-27 18:26:09 +01003583fullconn <conns>
3584 Specify at what backend load the servers will reach their maxconn
3585 May be used in sections : defaults | frontend | listen | backend
3586 yes | no | yes | yes
3587 Arguments :
3588 <conns> is the number of connections on the backend which will make the
3589 servers use the maximal number of connections.
3590
Willy Tarreau198a7442008-01-17 12:05:32 +01003591 When a server has a "maxconn" parameter specified, it means that its number
Willy Tarreau2769aa02007-12-27 18:26:09 +01003592 of concurrent connections will never go higher. Additionally, if it has a
Willy Tarreau198a7442008-01-17 12:05:32 +01003593 "minconn" parameter, it indicates a dynamic limit following the backend's
Willy Tarreau2769aa02007-12-27 18:26:09 +01003594 load. The server will then always accept at least <minconn> connections,
3595 never more than <maxconn>, and the limit will be on the ramp between both
3596 values when the backend has less than <conns> concurrent connections. This
3597 makes it possible to limit the load on the servers during normal loads, but
3598 push it further for important loads without overloading the servers during
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +01003599 exceptional loads.
Willy Tarreau2769aa02007-12-27 18:26:09 +01003600
Willy Tarreaufbb78422011-06-05 15:38:35 +02003601 Since it's hard to get this value right, haproxy automatically sets it to
3602 10% of the sum of the maxconns of all frontends that may branch to this
Bertrand Jacquin702d44f2013-11-19 11:43:06 +01003603 backend (based on "use_backend" and "default_backend" rules). That way it's
3604 safe to leave it unset. However, "use_backend" involving dynamic names are
3605 not counted since there is no way to know if they could match or not.
Willy Tarreaufbb78422011-06-05 15:38:35 +02003606
Willy Tarreau2769aa02007-12-27 18:26:09 +01003607 Example :
3608 # The servers will accept between 100 and 1000 concurrent connections each
3609 # and the maximum of 1000 will be reached when the backend reaches 10000
3610 # connections.
3611 backend dynamic
3612 fullconn 10000
3613 server srv1 dyn1:80 minconn 100 maxconn 1000
3614 server srv2 dyn2:80 minconn 100 maxconn 1000
3615
3616 See also : "maxconn", "server"
3617
3618
3619grace <time>
3620 Maintain a proxy operational for some time after a soft stop
3621 May be used in sections : defaults | frontend | listen | backend
Cyril Bonté99ed3272010-01-24 23:29:44 +01003622 yes | yes | yes | yes
Willy Tarreau2769aa02007-12-27 18:26:09 +01003623 Arguments :
3624 <time> is the time (by default in milliseconds) for which the instance
3625 will remain operational with the frontend sockets still listening
3626 when a soft-stop is received via the SIGUSR1 signal.
3627
3628 This may be used to ensure that the services disappear in a certain order.
3629 This was designed so that frontends which are dedicated to monitoring by an
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +01003630 external equipment fail immediately while other ones remain up for the time
Willy Tarreau2769aa02007-12-27 18:26:09 +01003631 needed by the equipment to detect the failure.
3632
3633 Note that currently, there is very little benefit in using this parameter,
3634 and it may in fact complicate the soft-reconfiguration process more than
3635 simplify it.
3636
Willy Tarreau0ba27502007-12-24 16:55:16 +01003637
Andrew Rodland17be45e2016-10-25 17:04:12 -04003638hash-balance-factor <factor>
3639 Specify the balancing factor for bounded-load consistent hashing
3640 May be used in sections : defaults | frontend | listen | backend
3641 yes | no | no | yes
3642 Arguments :
3643 <factor> is the control for the maximum number of concurrent requests to
3644 send to a server, expressed as a percentage of the average number
3645 of concurrent requests across all of the active servers.
3646
3647 Specifying a "hash-balance-factor" for a server with "hash-type consistent"
3648 enables an algorithm that prevents any one server from getting too many
3649 requests at once, even if some hash buckets receive many more requests than
3650 others. Setting <factor> to 0 (the default) disables the feature. Otherwise,
3651 <factor> is a percentage greater than 100. For example, if <factor> is 150,
3652 then no server will be allowed to have a load more than 1.5 times the average.
3653 If server weights are used, they will be respected.
3654
3655 If the first-choice server is disqualified, the algorithm will choose another
3656 server based on the request hash, until a server with additional capacity is
3657 found. A higher <factor> allows more imbalance between the servers, while a
3658 lower <factor> means that more servers will be checked on average, affecting
3659 performance. Reasonable values are from 125 to 200.
3660
Willy Tarreau760e81d2018-05-03 07:20:40 +02003661 This setting is also used by "balance random" which internally relies on the
3662 consistent hashing mechanism.
3663
Andrew Rodland17be45e2016-10-25 17:04:12 -04003664 See also : "balance" and "hash-type".
3665
3666
Bhaskar Maddalab6c0ac92013-11-05 11:54:02 -05003667hash-type <method> <function> <modifier>
Willy Tarreau6b2e11b2009-10-01 07:52:15 +02003668 Specify a method to use for mapping hashes to servers
3669 May be used in sections : defaults | frontend | listen | backend
3670 yes | no | yes | yes
3671 Arguments :
Bhaskar98634f02013-10-29 23:30:51 -04003672 <method> is the method used to select a server from the hash computed by
3673 the <function> :
Willy Tarreau6b2e11b2009-10-01 07:52:15 +02003674
Bhaskar98634f02013-10-29 23:30:51 -04003675 map-based the hash table is a static array containing all alive servers.
3676 The hashes will be very smooth, will consider weights, but
3677 will be static in that weight changes while a server is up
3678 will be ignored. This means that there will be no slow start.
3679 Also, since a server is selected by its position in the array,
3680 most mappings are changed when the server count changes. This
3681 means that when a server goes up or down, or when a server is
3682 added to a farm, most connections will be redistributed to
3683 different servers. This can be inconvenient with caches for
3684 instance.
Willy Tarreau798a39c2010-11-24 15:04:29 +01003685
Bhaskar98634f02013-10-29 23:30:51 -04003686 consistent the hash table is a tree filled with many occurrences of each
3687 server. The hash key is looked up in the tree and the closest
3688 server is chosen. This hash is dynamic, it supports changing
3689 weights while the servers are up, so it is compatible with the
3690 slow start feature. It has the advantage that when a server
3691 goes up or down, only its associations are moved. When a
3692 server is added to the farm, only a few part of the mappings
3693 are redistributed, making it an ideal method for caches.
3694 However, due to its principle, the distribution will never be
3695 very smooth and it may sometimes be necessary to adjust a
3696 server's weight or its ID to get a more balanced distribution.
3697 In order to get the same distribution on multiple load
3698 balancers, it is important that all servers have the exact
Bhaskar Maddalab6c0ac92013-11-05 11:54:02 -05003699 same IDs. Note: consistent hash uses sdbm and avalanche if no
3700 hash function is specified.
Bhaskar98634f02013-10-29 23:30:51 -04003701
3702 <function> is the hash function to be used :
3703
Jarno Huuskonen0e82b922014-04-12 18:22:19 +03003704 sdbm this function was created initially for sdbm (a public-domain
Bhaskar98634f02013-10-29 23:30:51 -04003705 reimplementation of ndbm) database library. It was found to do
3706 well in scrambling bits, causing better distribution of the keys
3707 and fewer splits. It also happens to be a good general hashing
Bhaskar Maddalab6c0ac92013-11-05 11:54:02 -05003708 function with good distribution, unless the total server weight
3709 is a multiple of 64, in which case applying the avalanche
3710 modifier may help.
Bhaskar98634f02013-10-29 23:30:51 -04003711
3712 djb2 this function was first proposed by Dan Bernstein many years ago
3713 on comp.lang.c. Studies have shown that for certain workload this
Bhaskar Maddalab6c0ac92013-11-05 11:54:02 -05003714 function provides a better distribution than sdbm. It generally
3715 works well with text-based inputs though it can perform extremely
3716 poorly with numeric-only input or when the total server weight is
3717 a multiple of 33, unless the avalanche modifier is also used.
3718
Willy Tarreaua0f42712013-11-14 14:30:35 +01003719 wt6 this function was designed for haproxy while testing other
3720 functions in the past. It is not as smooth as the other ones, but
3721 is much less sensible to the input data set or to the number of
3722 servers. It can make sense as an alternative to sdbm+avalanche or
3723 djb2+avalanche for consistent hashing or when hashing on numeric
3724 data such as a source IP address or a visitor identifier in a URL
3725 parameter.
3726
Willy Tarreau324f07f2015-01-20 19:44:50 +01003727 crc32 this is the most common CRC32 implementation as used in Ethernet,
3728 gzip, PNG, etc. It is slower than the other ones but may provide
3729 a better distribution or less predictable results especially when
3730 used on strings.
3731
Bhaskar Maddalab6c0ac92013-11-05 11:54:02 -05003732 <modifier> indicates an optional method applied after hashing the key :
3733
3734 avalanche This directive indicates that the result from the hash
3735 function above should not be used in its raw form but that
3736 a 4-byte full avalanche hash must be applied first. The
3737 purpose of this step is to mix the resulting bits from the
3738 previous hash in order to avoid any undesired effect when
3739 the input contains some limited values or when the number of
3740 servers is a multiple of one of the hash's components (64
3741 for SDBM, 33 for DJB2). Enabling avalanche tends to make the
3742 result less predictable, but it's also not as smooth as when
3743 using the original function. Some testing might be needed
3744 with some workloads. This hash is one of the many proposed
3745 by Bob Jenkins.
Willy Tarreau6b2e11b2009-10-01 07:52:15 +02003746
Bhaskar98634f02013-10-29 23:30:51 -04003747 The default hash type is "map-based" and is recommended for most usages. The
3748 default function is "sdbm", the selection of a function should be based on
3749 the range of the values being hashed.
Willy Tarreau6b2e11b2009-10-01 07:52:15 +02003750
Andrew Rodland17be45e2016-10-25 17:04:12 -04003751 See also : "balance", "hash-balance-factor", "server"
Willy Tarreau6b2e11b2009-10-01 07:52:15 +02003752
3753
Willy Tarreau0ba27502007-12-24 16:55:16 +01003754http-check disable-on-404
3755 Enable a maintenance mode upon HTTP/404 response to health-checks
3756 May be used in sections : defaults | frontend | listen | backend
Willy Tarreau2769aa02007-12-27 18:26:09 +01003757 yes | no | yes | yes
Willy Tarreau0ba27502007-12-24 16:55:16 +01003758 Arguments : none
3759
3760 When this option is set, a server which returns an HTTP code 404 will be
3761 excluded from further load-balancing, but will still receive persistent
3762 connections. This provides a very convenient method for Web administrators
3763 to perform a graceful shutdown of their servers. It is also important to note
3764 that a server which is detected as failed while it was in this mode will not
3765 generate an alert, just a notice. If the server responds 2xx or 3xx again, it
3766 will immediately be reinserted into the farm. The status on the stats page
3767 reports "NOLB" for a server in this mode. It is important to note that this
Willy Tarreaubd741542010-03-16 18:46:54 +01003768 option only works in conjunction with the "httpchk" option. If this option
3769 is used with "http-check expect", then it has precedence over it so that 404
3770 responses will still be considered as soft-stop.
3771
3772 See also : "option httpchk", "http-check expect"
3773
3774
3775http-check expect [!] <match> <pattern>
Jamie Gloudonaaa21002012-08-25 00:18:33 -04003776 Make HTTP health checks consider response contents or specific status codes
Willy Tarreaubd741542010-03-16 18:46:54 +01003777 May be used in sections : defaults | frontend | listen | backend
Willy Tarreau1ee51a62011-08-19 20:04:17 +02003778 yes | no | yes | yes
Willy Tarreaubd741542010-03-16 18:46:54 +01003779 Arguments :
3780 <match> is a keyword indicating how to look for a specific pattern in the
3781 response. The keyword may be one of "status", "rstatus",
Jamie Gloudonaaa21002012-08-25 00:18:33 -04003782 "string", or "rstring". The keyword may be preceded by an
Willy Tarreaubd741542010-03-16 18:46:54 +01003783 exclamation mark ("!") to negate the match. Spaces are allowed
3784 between the exclamation mark and the keyword. See below for more
3785 details on the supported keywords.
3786
3787 <pattern> is the pattern to look for. It may be a string or a regular
3788 expression. If the pattern contains spaces, they must be escaped
3789 with the usual backslash ('\').
3790
3791 By default, "option httpchk" considers that response statuses 2xx and 3xx
3792 are valid, and that others are invalid. When "http-check expect" is used,
3793 it defines what is considered valid or invalid. Only one "http-check"
3794 statement is supported in a backend. If a server fails to respond or times
3795 out, the check obviously fails. The available matches are :
3796
3797 status <string> : test the exact string match for the HTTP status code.
Jamie Gloudonaaa21002012-08-25 00:18:33 -04003798 A health check response will be considered valid if the
Willy Tarreaubd741542010-03-16 18:46:54 +01003799 response's status code is exactly this string. If the
3800 "status" keyword is prefixed with "!", then the response
3801 will be considered invalid if the status code matches.
3802
3803 rstatus <regex> : test a regular expression for the HTTP status code.
Jamie Gloudonaaa21002012-08-25 00:18:33 -04003804 A health check response will be considered valid if the
Willy Tarreaubd741542010-03-16 18:46:54 +01003805 response's status code matches the expression. If the
3806 "rstatus" keyword is prefixed with "!", then the response
3807 will be considered invalid if the status code matches.
3808 This is mostly used to check for multiple codes.
3809
3810 string <string> : test the exact string match in the HTTP response body.
Jamie Gloudonaaa21002012-08-25 00:18:33 -04003811 A health check response will be considered valid if the
Willy Tarreaubd741542010-03-16 18:46:54 +01003812 response's body contains this exact string. If the
3813 "string" keyword is prefixed with "!", then the response
3814 will be considered invalid if the body contains this
3815 string. This can be used to look for a mandatory word at
3816 the end of a dynamic page, or to detect a failure when a
Davor Ocelice9ed2812017-12-25 17:49:28 +01003817 specific error appears on the check page (e.g. a stack
Willy Tarreaubd741542010-03-16 18:46:54 +01003818 trace).
3819
3820 rstring <regex> : test a regular expression on the HTTP response body.
Jamie Gloudonaaa21002012-08-25 00:18:33 -04003821 A health check response will be considered valid if the
Willy Tarreaubd741542010-03-16 18:46:54 +01003822 response's body matches this expression. If the "rstring"
3823 keyword is prefixed with "!", then the response will be
3824 considered invalid if the body matches the expression.
3825 This can be used to look for a mandatory word at the end
3826 of a dynamic page, or to detect a failure when a specific
Davor Ocelice9ed2812017-12-25 17:49:28 +01003827 error appears on the check page (e.g. a stack trace).
Willy Tarreaubd741542010-03-16 18:46:54 +01003828
3829 It is important to note that the responses will be limited to a certain size
3830 defined by the global "tune.chksize" option, which defaults to 16384 bytes.
3831 Thus, too large responses may not contain the mandatory pattern when using
3832 "string" or "rstring". If a large response is absolutely required, it is
3833 possible to change the default max size by setting the global variable.
3834 However, it is worth keeping in mind that parsing very large responses can
3835 waste some CPU cycles, especially when regular expressions are used, and that
3836 it is always better to focus the checks on smaller resources.
3837
Cyril Bonté32602d22015-01-30 00:07:07 +01003838 Also "http-check expect" doesn't support HTTP keep-alive. Keep in mind that it
3839 will automatically append a "Connection: close" header, meaning that this
3840 header should not be present in the request provided by "option httpchk".
3841
Willy Tarreaubd741542010-03-16 18:46:54 +01003842 Last, if "http-check expect" is combined with "http-check disable-on-404",
3843 then this last one has precedence when the server responds with 404.
3844
3845 Examples :
3846 # only accept status 200 as valid
Willy Tarreau8f2a1e72011-01-06 16:36:10 +01003847 http-check expect status 200
Willy Tarreaubd741542010-03-16 18:46:54 +01003848
3849 # consider SQL errors as errors
Willy Tarreau8f2a1e72011-01-06 16:36:10 +01003850 http-check expect ! string SQL\ Error
Willy Tarreaubd741542010-03-16 18:46:54 +01003851
3852 # consider status 5xx only as errors
Willy Tarreau8f2a1e72011-01-06 16:36:10 +01003853 http-check expect ! rstatus ^5
Willy Tarreaubd741542010-03-16 18:46:54 +01003854
3855 # check that we have a correct hexadecimal tag before /html
Jarno Huuskonene5ae7022017-04-03 14:36:21 +03003856 http-check expect rstring <!--tag:[0-9a-f]*--></html>
Willy Tarreau0ba27502007-12-24 16:55:16 +01003857
Willy Tarreaubd741542010-03-16 18:46:54 +01003858 See also : "option httpchk", "http-check disable-on-404"
Willy Tarreau2769aa02007-12-27 18:26:09 +01003859
3860
Willy Tarreauef781042010-01-27 11:53:01 +01003861http-check send-state
3862 Enable emission of a state header with HTTP health checks
3863 May be used in sections : defaults | frontend | listen | backend
3864 yes | no | yes | yes
3865 Arguments : none
3866
3867 When this option is set, haproxy will systematically send a special header
3868 "X-Haproxy-Server-State" with a list of parameters indicating to each server
3869 how they are seen by haproxy. This can be used for instance when a server is
3870 manipulated without access to haproxy and the operator needs to know whether
3871 haproxy still sees it up or not, or if the server is the last one in a farm.
3872
3873 The header is composed of fields delimited by semi-colons, the first of which
3874 is a word ("UP", "DOWN", "NOLB"), possibly followed by a number of valid
3875 checks on the total number before transition, just as appears in the stats
3876 interface. Next headers are in the form "<variable>=<value>", indicating in
3877 no specific order some values available in the stats interface :
Joseph Lynch514061c2015-01-15 17:52:59 -08003878 - a variable "address", containing the address of the backend server.
3879 This corresponds to the <address> field in the server declaration. For
3880 unix domain sockets, it will read "unix".
3881
3882 - a variable "port", containing the port of the backend server. This
3883 corresponds to the <port> field in the server declaration. For unix
3884 domain sockets, it will read "unix".
3885
Willy Tarreauef781042010-01-27 11:53:01 +01003886 - a variable "name", containing the name of the backend followed by a slash
3887 ("/") then the name of the server. This can be used when a server is
3888 checked in multiple backends.
3889
3890 - a variable "node" containing the name of the haproxy node, as set in the
3891 global "node" variable, otherwise the system's hostname if unspecified.
3892
3893 - a variable "weight" indicating the weight of the server, a slash ("/")
3894 and the total weight of the farm (just counting usable servers). This
3895 helps to know if other servers are available to handle the load when this
3896 one fails.
3897
3898 - a variable "scur" indicating the current number of concurrent connections
3899 on the server, followed by a slash ("/") then the total number of
3900 connections on all servers of the same backend.
3901
3902 - a variable "qcur" indicating the current number of requests in the
3903 server's queue.
3904
3905 Example of a header received by the application server :
3906 >>> X-Haproxy-Server-State: UP 2/3; name=bck/srv2; node=lb1; weight=1/2; \
3907 scur=13/22; qcur=0
3908
3909 See also : "option httpchk", "http-check disable-on-404"
3910
Willy Tarreau53275e82017-11-24 07:52:01 +01003911http-request { allow | auth [realm <realm>] | redirect <rule> | reject |
Jarno Huuskonen800d1762017-03-06 14:56:36 +02003912 tarpit [deny_status <status>] | deny [deny_status <status>] |
Willy Tarreauf4c43c12013-06-11 17:01:13 +02003913 add-header <name> <fmt> | set-header <name> <fmt> |
Thierry FOURNIER82bf70d2015-05-26 17:58:29 +02003914 capture <sample> [ len <length> | id <id> ] |
Thierry FOURNIERdad3d1d2014-04-22 18:07:25 +02003915 del-header <name> | set-nice <nice> | set-log-level <level> |
Sasha Pachev218f0642014-06-16 12:05:59 -06003916 replace-header <name> <match-regex> <replace-fmt> |
3917 replace-value <name> <match-regex> <replace-fmt> |
Willy Tarreaua0dc23f2015-01-22 20:46:11 +01003918 set-method <fmt> | set-path <fmt> | set-query <fmt> |
3919 set-uri <fmt> | set-tos <tos> | set-mark <mark> |
Patrick Hemmer268a7072018-05-11 12:52:31 -04003920 set-priority-class <expr> | set-priority-offset <expr>
Baptiste Assmannfabcbe02014-04-24 22:16:59 +02003921 add-acl(<file name>) <key fmt> |
3922 del-acl(<file name>) <key fmt> |
3923 del-map(<file name>) <key fmt> |
Baptiste Assmannbb7e86a2014-09-03 18:29:47 +02003924 set-map(<file name>) <key fmt> <value fmt> |
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02003925 set-var(<var name>) <expr> |
Christopher Faulet85d79c92016-11-09 16:54:56 +01003926 unset-var(<var name>) |
Thierry FOURNIER90da1912015-03-05 11:17:06 +01003927 { track-sc0 | track-sc1 | track-sc2 } <key> [table <table>] |
Thierry FOURNIERe0627bd2015-08-04 08:20:33 +02003928 sc-inc-gpc0(<sc-id>) |
Frédéric Lécaille6778b272018-01-29 15:22:53 +01003929 sc-inc-gpc1(<sc-id>) |
Thierry FOURNIER236657b2015-08-19 08:25:14 +02003930 sc-set-gpt0(<sc-id>) <int> |
Willy Tarreau2d392c22015-08-24 01:43:45 +02003931 silent-drop |
William Lallemand86d0df02017-11-24 21:36:45 +01003932 send-spoe-group |
3933 cache-use
Baptiste Assmannfabcbe02014-04-24 22:16:59 +02003934 }
Cyril Bontéf0c60612010-02-06 14:44:47 +01003935 [ { if | unless } <condition> ]
Krzysztof Piotr Oledzki6b35ce12010-02-01 23:35:44 +01003936 Access control for Layer 7 requests
3937
3938 May be used in sections: defaults | frontend | listen | backend
3939 no | yes | yes | yes
3940
Willy Tarreau20b0de52012-12-24 15:45:22 +01003941 The http-request statement defines a set of rules which apply to layer 7
3942 processing. The rules are evaluated in their declaration order when they are
3943 met in a frontend, listen or backend section. Any rule may optionally be
3944 followed by an ACL-based condition, in which case it will only be evaluated
3945 if the condition is true.
Krzysztof Piotr Oledzki6b35ce12010-02-01 23:35:44 +01003946
Willy Tarreau20b0de52012-12-24 15:45:22 +01003947 The first keyword is the rule's action. Currently supported actions include :
3948 - "allow" : this stops the evaluation of the rules and lets the request
3949 pass the check. No further "http-request" rules are evaluated.
3950
3951 - "deny" : this stops the evaluation of the rules and immediately rejects
Willy Tarreaube1d34d2016-06-26 19:37:59 +02003952 the request and emits an HTTP 403 error, or optionally the status code
3953 specified as an argument to "deny_status". The list of permitted status
3954 codes is limited to those that can be overridden by the "errorfile"
3955 directive. No further "http-request" rules are evaluated.
Willy Tarreau20b0de52012-12-24 15:45:22 +01003956
Willy Tarreau53275e82017-11-24 07:52:01 +01003957 - "reject" : this stops the evaluation of the rules and immediately closes
3958 the connection without sending any response. It acts similarly to the
3959 "tcp-request content reject" rules. It can be useful to force an
3960 immediate connection closure on HTTP/2 connections.
3961
Willy Tarreauccbcc372012-12-27 12:37:57 +01003962 - "tarpit" : this stops the evaluation of the rules and immediately blocks
3963 the request without responding for a delay specified by "timeout tarpit"
3964 or "timeout connect" if the former is not set. After that delay, if the
Jarno Huuskonen800d1762017-03-06 14:56:36 +02003965 client is still connected, an HTTP error 500 (or optionally the status
3966 code specified as an argument to "deny_status") is returned so that the
Willy Tarreauccbcc372012-12-27 12:37:57 +01003967 client does not suspect it has been tarpitted. Logs will report the flags
3968 "PT". The goal of the tarpit rule is to slow down robots during an attack
3969 when they're limited on the number of concurrent requests. It can be very
3970 efficient against very dumb robots, and will significantly reduce the
3971 load on firewalls compared to a "deny" rule. But when facing "correctly"
Jarno Huuskonen0e82b922014-04-12 18:22:19 +03003972 developed robots, it can make things worse by forcing haproxy and the
Willy Tarreau2d392c22015-08-24 01:43:45 +02003973 front firewall to support insane number of concurrent connections. See
3974 also the "silent-drop" action below.
Willy Tarreauccbcc372012-12-27 12:37:57 +01003975
Willy Tarreau20b0de52012-12-24 15:45:22 +01003976 - "auth" : this stops the evaluation of the rules and immediately responds
3977 with an HTTP 401 or 407 error code to invite the user to present a valid
3978 user name and password. No further "http-request" rules are evaluated. An
3979 optional "realm" parameter is supported, it sets the authentication realm
3980 that is returned with the response (typically the application's name).
3981
Willy Tarreau81499eb2012-12-27 12:19:02 +01003982 - "redirect" : this performs an HTTP redirection based on a redirect rule.
3983 This is exactly the same as the "redirect" statement except that it
3984 inserts a redirect rule which can be processed in the middle of other
Thierry FOURNIERd18cd0f2013-11-29 12:15:45 +01003985 "http-request" rules and that these rules use the "log-format" strings.
3986 See the "redirect" keyword for the rule's syntax.
Willy Tarreau81499eb2012-12-27 12:19:02 +01003987
Willy Tarreau20b0de52012-12-24 15:45:22 +01003988 - "add-header" appends an HTTP header field whose name is specified in
3989 <name> and whose value is defined by <fmt> which follows the log-format
3990 rules (see Custom Log Format in section 8.2.4). This is particularly
Davor Ocelice9ed2812017-12-25 17:49:28 +01003991 useful to pass connection-specific information to the server (e.g. the
Willy Tarreau20b0de52012-12-24 15:45:22 +01003992 client's SSL certificate), or to combine several headers into one. This
3993 rule is not final, so it is possible to add other similar rules. Note
3994 that header addition is performed immediately, so one rule might reuse
3995 the resulting header from a previous rule.
3996
3997 - "set-header" does the same as "add-header" except that the header name
3998 is first removed if it existed. This is useful when passing security
3999 information to the server, where the header must not be manipulated by
Willy Tarreau85603282015-01-21 20:39:27 +01004000 external users. Note that the new value is computed before the removal so
4001 it is possible to concatenate a value to an existing header.
Willy Tarreau20b0de52012-12-24 15:45:22 +01004002
Thierry FOURNIERdad3d1d2014-04-22 18:07:25 +02004003 - "del-header" removes all HTTP header fields whose name is specified in
4004 <name>.
4005
Sasha Pachev218f0642014-06-16 12:05:59 -06004006 - "replace-header" matches the regular expression in all occurrences of
4007 header field <name> according to <match-regex>, and replaces them with
4008 the <replace-fmt> argument. Format characters are allowed in replace-fmt
4009 and work like in <fmt> arguments in "add-header". The match is only
4010 case-sensitive. It is important to understand that this action only
4011 considers whole header lines, regardless of the number of values they
4012 may contain. This usage is suited to headers naturally containing commas
4013 in their value, such as If-Modified-Since and so on.
4014
4015 Example:
4016
4017 http-request replace-header Cookie foo=([^;]*);(.*) foo=\1;ip=%bi;\2
4018
4019 applied to:
4020
4021 Cookie: foo=foobar; expires=Tue, 14-Jun-2016 01:40:45 GMT;
4022
4023 outputs:
4024
4025 Cookie: foo=foobar;ip=192.168.1.20; expires=Tue, 14-Jun-2016 01:40:45 GMT;
4026
4027 assuming the backend IP is 192.168.1.20
4028
4029 - "replace-value" works like "replace-header" except that it matches the
4030 regex against every comma-delimited value of the header field <name>
4031 instead of the entire header. This is suited for all headers which are
4032 allowed to carry more than one value. An example could be the Accept
4033 header.
4034
4035 Example:
4036
4037 http-request replace-value X-Forwarded-For ^192\.168\.(.*)$ 172.16.\1
4038
4039 applied to:
4040
4041 X-Forwarded-For: 192.168.10.1, 192.168.13.24, 10.0.0.37
4042
4043 outputs:
4044
4045 X-Forwarded-For: 172.16.10.1, 172.16.13.24, 10.0.0.37
4046
Willy Tarreaua0dc23f2015-01-22 20:46:11 +01004047 - "set-method" rewrites the request method with the result of the
4048 evaluation of format string <fmt>. There should be very few valid reasons
4049 for having to do so as this is more likely to break something than to fix
4050 it.
4051
4052 - "set-path" rewrites the request path with the result of the evaluation of
4053 format string <fmt>. The query string, if any, is left intact. If a
4054 scheme and authority is found before the path, they are left intact as
4055 well. If the request doesn't have a path ("*"), this one is replaced with
4056 the format. This can be used to prepend a directory component in front of
4057 a path for example. See also "set-query" and "set-uri".
4058
4059 Example :
4060 # prepend the host name before the path
4061 http-request set-path /%[hdr(host)]%[path]
4062
4063 - "set-query" rewrites the request's query string which appears after the
4064 first question mark ("?") with the result of the evaluation of format
4065 string <fmt>. The part prior to the question mark is left intact. If the
4066 request doesn't contain a question mark and the new value is not empty,
4067 then one is added at the end of the URI, followed by the new value. If
4068 a question mark was present, it will never be removed even if the value
4069 is empty. This can be used to add or remove parameters from the query
4070 string. See also "set-query" and "set-uri".
4071
4072 Example :
4073 # replace "%3D" with "=" in the query string
4074 http-request set-query %[query,regsub(%3D,=,g)]
4075
4076 - "set-uri" rewrites the request URI with the result of the evaluation of
4077 format string <fmt>. The scheme, authority, path and query string are all
4078 replaced at once. This can be used to rewrite hosts in front of proxies,
4079 or to perform complex modifications to the URI such as moving parts
4080 between the path and the query string. See also "set-path" and
4081 "set-query".
4082
Willy Tarreauf4c43c12013-06-11 17:01:13 +02004083 - "set-nice" sets the "nice" factor of the current request being processed.
4084 It only has effect against the other requests being processed at the same
4085 time. The default value is 0, unless altered by the "nice" setting on the
4086 "bind" line. The accepted range is -1024..1024. The higher the value, the
4087 nicest the request will be. Lower values will make the request more
4088 important than other ones. This can be useful to improve the speed of
4089 some requests, or lower the priority of non-important requests. Using
4090 this setting without prior experimentation can cause some major slowdown.
4091
Willy Tarreau9a355ec2013-06-11 17:45:46 +02004092 - "set-log-level" is used to change the log level of the current request
4093 when a certain condition is met. Valid levels are the 8 syslog levels
4094 (see the "log" keyword) plus the special level "silent" which disables
4095 logging for this request. This rule is not final so the last matching
4096 rule wins. This rule can be useful to disable health checks coming from
4097 another equipment.
4098
Willy Tarreau42cf39e2013-06-11 18:51:32 +02004099 - "set-tos" is used to set the TOS or DSCP field value of packets sent to
4100 the client to the value passed in <tos> on platforms which support this.
4101 This value represents the whole 8 bits of the IP TOS field, and can be
4102 expressed both in decimal or hexadecimal format (prefixed by "0x"). Note
4103 that only the 6 higher bits are used in DSCP or TOS, and the two lower
Davor Ocelice9ed2812017-12-25 17:49:28 +01004104 bits are always 0. This can be used to adjust some routing behavior on
Willy Tarreau42cf39e2013-06-11 18:51:32 +02004105 border routers based on some information from the request. See RFC 2474,
4106 2597, 3260 and 4594 for more information.
4107
Willy Tarreau51347ed2013-06-11 19:34:13 +02004108 - "set-mark" is used to set the Netfilter MARK on all packets sent to the
4109 client to the value passed in <mark> on platforms which support it. This
4110 value is an unsigned 32 bit value which can be matched by netfilter and
4111 by the routing table. It can be expressed both in decimal or hexadecimal
4112 format (prefixed by "0x"). This can be useful to force certain packets to
4113 take a different route (for example a cheaper network path for bulk
4114 downloads). This works on Linux kernels 2.6.32 and above and requires
4115 admin privileges.
4116
Patrick Hemmer268a7072018-05-11 12:52:31 -04004117 - "set-priority-class" is used to set the queue priority class of the
4118 current request. The value must be a sample expression which converts to
4119 an integer in the range -2047..2047. Results outside this range will be
4120 truncated. The priority class determines the order in which queued
4121 requests are processed. Lower values have higher priority.
4122
4123 - "set-priority-offset" is used to set the queue priority timestamp offset
4124 of the current request. The value must be a sample expression which
4125 converts to an integer in the range -524287..524287. Results outside this
4126 range will be truncated. When a request is queued, it is ordered first by
4127 the priority class, then by the current timestamp adjusted by the given
4128 offset in milliseconds. Lower values have higher priority.
4129 Note that the resulting timestamp is is only tracked with enough precision
4130 for 524,287ms (8m44s287ms). If the request is queued long enough to where
4131 the adjusted timestamp exceeds this value, it will be misidentified as
4132 highest priority. Thus it is important to set "timeout queue" to a value,
4133 where when combined with the offset, does not exceed this limit.
4134
Baptiste Assmannfabcbe02014-04-24 22:16:59 +02004135 - "add-acl" is used to add a new entry into an ACL. The ACL must be loaded
4136 from a file (even a dummy empty file). The file name of the ACL to be
4137 updated is passed between parentheses. It takes one argument: <key fmt>,
4138 which follows log-format rules, to collect content of the new entry. It
4139 performs a lookup in the ACL before insertion, to avoid duplicated (or
4140 more) values. This lookup is done by a linear search and can be expensive
4141 with large lists! It is the equivalent of the "add acl" command from the
4142 stats socket, but can be triggered by an HTTP request.
4143
4144 - "del-acl" is used to delete an entry from an ACL. The ACL must be loaded
4145 from a file (even a dummy empty file). The file name of the ACL to be
4146 updated is passed between parentheses. It takes one argument: <key fmt>,
4147 which follows log-format rules, to collect content of the entry to delete.
4148 It is the equivalent of the "del acl" command from the stats socket, but
4149 can be triggered by an HTTP request.
4150
4151 - "del-map" is used to delete an entry from a MAP. The MAP must be loaded
4152 from a file (even a dummy empty file). The file name of the MAP to be
4153 updated is passed between parentheses. It takes one argument: <key fmt>,
4154 which follows log-format rules, to collect content of the entry to delete.
4155 It takes one argument: "file name" It is the equivalent of the "del map"
4156 command from the stats socket, but can be triggered by an HTTP request.
4157
4158 - "set-map" is used to add a new entry into a MAP. The MAP must be loaded
4159 from a file (even a dummy empty file). The file name of the MAP to be
4160 updated is passed between parentheses. It takes 2 arguments: <key fmt>,
4161 which follows log-format rules, used to collect MAP key, and <value fmt>,
4162 which follows log-format rules, used to collect content for the new entry.
4163 It performs a lookup in the MAP before insertion, to avoid duplicated (or
4164 more) values. This lookup is done by a linear search and can be expensive
4165 with large lists! It is the equivalent of the "set map" command from the
4166 stats socket, but can be triggered by an HTTP request.
4167
Thierry FOURNIER82bf70d2015-05-26 17:58:29 +02004168 - capture <sample> [ len <length> | id <id> ] :
Willy Tarreaua9083d02015-05-08 15:27:59 +02004169 captures sample expression <sample> from the request buffer, and converts
4170 it to a string of at most <len> characters. The resulting string is
4171 stored into the next request "capture" slot, so it will possibly appear
4172 next to some captured HTTP headers. It will then automatically appear in
4173 the logs, and it will be possible to extract it using sample fetch rules
4174 to feed it into headers or anything. The length should be limited given
4175 that this size will be allocated for each capture during the whole
4176 session life. Please check section 7.3 (Fetching samples) and "capture
4177 request header" for more information.
4178
Thierry FOURNIER82bf70d2015-05-26 17:58:29 +02004179 If the keyword "id" is used instead of "len", the action tries to store
4180 the captured string in a previously declared capture slot. This is useful
4181 to run captures in backends. The slot id can be declared by a previous
4182 directive "http-request capture" or with the "declare capture" keyword.
Baptiste Assmanne9544932015-11-03 23:31:35 +01004183 If the slot <id> doesn't exist, then HAProxy fails parsing the
4184 configuration to prevent unexpected behavior at run time.
Thierry FOURNIER82bf70d2015-05-26 17:58:29 +02004185
William Lallemand86d0df02017-11-24 21:36:45 +01004186 - cache-use <name> :
4187 See section 10.2 about cache setup.
4188
Willy Tarreau09448f72014-06-25 18:12:15 +02004189 - { track-sc0 | track-sc1 | track-sc2 } <key> [table <table>] :
4190 enables tracking of sticky counters from current request. These rules
4191 do not stop evaluation and do not change default action. Three sets of
4192 counters may be simultaneously tracked by the same connection. The first
4193 "track-sc0" rule executed enables tracking of the counters of the
4194 specified table as the first set. The first "track-sc1" rule executed
4195 enables tracking of the counters of the specified table as the second
4196 set. The first "track-sc2" rule executed enables tracking of the
4197 counters of the specified table as the third set. It is a recommended
4198 practice to use the first set of counters for the per-frontend counters
4199 and the second set for the per-backend ones. But this is just a
4200 guideline, all may be used everywhere.
4201
4202 These actions take one or two arguments :
4203 <key> is mandatory, and is a sample expression rule as described
4204 in section 7.3. It describes what elements of the incoming
Davor Ocelice9ed2812017-12-25 17:49:28 +01004205 request or connection will be analyzed, extracted, combined,
Willy Tarreau09448f72014-06-25 18:12:15 +02004206 and used to select which table entry to update the counters.
4207
4208 <table> is an optional table to be used instead of the default one,
4209 which is the stick-table declared in the current proxy. All
4210 the counters for the matches and updates for the key will
4211 then be performed in that table until the session ends.
4212
4213 Once a "track-sc*" rule is executed, the key is looked up in the table
4214 and if it is not found, an entry is allocated for it. Then a pointer to
4215 that entry is kept during all the session's life, and this entry's
4216 counters are updated as often as possible, every time the session's
4217 counters are updated, and also systematically when the session ends.
4218 Counters are only updated for events that happen after the tracking has
4219 been started. As an exception, connection counters and request counters
4220 are systematically updated so that they reflect useful information.
4221
4222 If the entry tracks concurrent connection counters, one connection is
4223 counted for as long as the entry is tracked, and the entry will not
4224 expire during that time. Tracking counters also provides a performance
4225 advantage over just checking the keys, because only one table lookup is
4226 performed for all ACL checks that make use of it.
4227
Thierry FOURNIER236657b2015-08-19 08:25:14 +02004228 - sc-set-gpt0(<sc-id>) <int> :
4229 This action sets the GPT0 tag according to the sticky counter designated
4230 by <sc-id> and the value of <int>. The expected result is a boolean. If
4231 an error occurs, this action silently fails and the actions evaluation
4232 continues.
4233
Thierry FOURNIERe0627bd2015-08-04 08:20:33 +02004234 - sc-inc-gpc0(<sc-id>):
4235 This action increments the GPC0 counter according with the sticky counter
4236 designated by <sc-id>. If an error occurs, this action silently fails and
4237 the actions evaluation continues.
4238
Frédéric Lécaille6778b272018-01-29 15:22:53 +01004239 - sc-inc-gpc1(<sc-id>):
4240 Same as "sc-inc-gpc0" action above but for GPC1 counter.
4241
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02004242 - set-var(<var-name>) <expr> :
4243 Is used to set the contents of a variable. The variable is declared
4244 inline.
4245
Daniel Schneller0b547052016-03-21 20:46:57 +01004246 <var-name> The name of the variable starts with an indication about
4247 its scope. The scopes allowed are:
Christopher Fauletff2613e2016-11-09 11:36:17 +01004248 "proc" : the variable is shared with the whole process
Daniel Schneller0b547052016-03-21 20:46:57 +01004249 "sess" : the variable is shared with the whole session
4250 "txn" : the variable is shared with the transaction
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02004251 (request and response)
Daniel Schneller0b547052016-03-21 20:46:57 +01004252 "req" : the variable is shared only during request
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02004253 processing
Daniel Schneller0b547052016-03-21 20:46:57 +01004254 "res" : the variable is shared only during response
4255 processing
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02004256 This prefix is followed by a name. The separator is a '.'.
Daniel Schneller0b547052016-03-21 20:46:57 +01004257 The name may only contain characters 'a-z', 'A-Z', '0-9'
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02004258 and '_'.
4259
4260 <expr> Is a standard HAProxy expression formed by a sample-fetch
4261 followed by some converters.
4262
4263 Example:
4264
4265 http-request set-var(req.my_var) req.fhdr(user-agent),lower
4266
Christopher Faulet85d79c92016-11-09 16:54:56 +01004267 - unset-var(<var-name>) :
4268 Is used to unset a variable. See above for details about <var-name>.
4269
4270 Example:
4271
4272 http-request unset-var(req.my_var)
4273
Adis Nezirovic2fbcafc2015-07-06 15:44:30 +02004274 - set-src <expr> :
4275 Is used to set the source IP address to the value of specified
4276 expression. Useful when a proxy in front of HAProxy rewrites source IP,
4277 but provides the correct IP in a HTTP header; or you want to mask
4278 source IP for privacy.
4279
4280 <expr> Is a standard HAProxy expression formed by a sample-fetch
4281 followed by some converters.
4282
4283 Example:
4284
4285 http-request set-src hdr(x-forwarded-for)
4286 http-request set-src src,ipmask(24)
4287
Willy Tarreau00005ce2016-10-21 15:07:45 +02004288 When possible, set-src preserves the original source port as long as the
4289 address family allows it, otherwise the source port is set to 0.
Adis Nezirovic2fbcafc2015-07-06 15:44:30 +02004290
William Lallemand44be6402016-05-25 01:51:35 +02004291 - set-src-port <expr> :
4292 Is used to set the source port address to the value of specified
4293 expression.
4294
4295 <expr> Is a standard HAProxy expression formed by a sample-fetch
4296 followed by some converters.
4297
4298 Example:
4299
4300 http-request set-src-port hdr(x-port)
4301 http-request set-src-port int(4000)
4302
Willy Tarreau00005ce2016-10-21 15:07:45 +02004303 When possible, set-src-port preserves the original source address as long
4304 as the address family supports a port, otherwise it forces the source
4305 address to IPv4 "0.0.0.0" before rewriting the port.
William Lallemand44be6402016-05-25 01:51:35 +02004306
William Lallemand13e9b0c2016-05-25 02:34:07 +02004307 - set-dst <expr> :
4308 Is used to set the destination IP address to the value of specified
4309 expression. Useful when a proxy in front of HAProxy rewrites destination
4310 IP, but provides the correct IP in a HTTP header; or you want to mask
4311 the IP for privacy. If you want to connect to the new address/port, use
4312 '0.0.0.0:0' as a server address in the backend.
4313
4314 <expr> Is a standard HAProxy expression formed by a sample-fetch
4315 followed by some converters.
4316
4317 Example:
4318
4319 http-request set-dst hdr(x-dst)
4320 http-request set-dst dst,ipmask(24)
4321
Willy Tarreau00005ce2016-10-21 15:07:45 +02004322 When possible, set-dst preserves the original destination port as long as
4323 the address family allows it, otherwise the destination port is set to 0.
4324
William Lallemand13e9b0c2016-05-25 02:34:07 +02004325 - set-dst-port <expr> :
4326 Is used to set the destination port address to the value of specified
4327 expression. If you want to connect to the new address/port, use
4328 '0.0.0.0:0' as a server address in the backend.
4329
4330 <expr> Is a standard HAProxy expression formed by a sample-fetch
4331 followed by some converters.
4332
4333 Example:
4334
4335 http-request set-dst-port hdr(x-port)
4336 http-request set-dst-port int(4000)
4337
Willy Tarreau00005ce2016-10-21 15:07:45 +02004338 When possible, set-dst-port preserves the original destination address as
4339 long as the address family supports a port, otherwise it forces the
4340 destination address to IPv4 "0.0.0.0" before rewriting the port.
4341
Willy Tarreau2d392c22015-08-24 01:43:45 +02004342 - "silent-drop" : this stops the evaluation of the rules and makes the
Davor Ocelice9ed2812017-12-25 17:49:28 +01004343 client-facing connection suddenly disappear using a system-dependent way
Willy Tarreau2d392c22015-08-24 01:43:45 +02004344 that tries to prevent the client from being notified. The effect it then
4345 that the client still sees an established connection while there's none
4346 on HAProxy. The purpose is to achieve a comparable effect to "tarpit"
4347 except that it doesn't use any local resource at all on the machine
4348 running HAProxy. It can resist much higher loads than "tarpit", and slow
Davor Ocelice9ed2812017-12-25 17:49:28 +01004349 down stronger attackers. It is important to understand the impact of using
4350 this mechanism. All stateful equipment placed between the client and
Willy Tarreau2d392c22015-08-24 01:43:45 +02004351 HAProxy (firewalls, proxies, load balancers) will also keep the
4352 established connection for a long time and may suffer from this action.
4353 On modern Linux systems running with enough privileges, the TCP_REPAIR
4354 socket option is used to block the emission of a TCP reset. On other
4355 systems, the socket's TTL is reduced to 1 so that the TCP reset doesn't
4356 pass the first router, though it's still delivered to local networks. Do
4357 not use it unless you fully understand how it works.
4358
Christopher Faulet76c09ef2017-09-21 11:03:52 +02004359
Olivier Houchardccaa7de2017-10-02 11:51:03 +02004360 - "wait-for-handshake" : this will delay the processing of the request
4361 until the SSL handshake happened. This is mostly useful to delay
4362 processing early data until we're sure they are valid.
4363
Christopher Faulet76c09ef2017-09-21 11:03:52 +02004364 - send-spoe-group <engine-name> <group-name> :
4365 This action is used to trigger sending of a group of SPOE messages. To do
4366 so, the SPOE engine used to send messages must be defined, as well as the
4367 SPOE group to send. Of course, the SPOE engine must refer to an existing
4368 SPOE filter. If not engine name is provided on the SPOE filter line, the
4369 SPOE agent name must be used.
4370
4371 <engine-name> The SPOE engine name.
4372
4373 <group-name> The SPOE group name as specified in the engine
4374 configuration.
4375
Willy Tarreau20b0de52012-12-24 15:45:22 +01004376 There is no limit to the number of http-request statements per instance.
4377
4378 It is important to know that http-request rules are processed very early in
4379 the HTTP processing, just after "block" rules and before "reqdel" or "reqrep"
Ruoshan Huangeb5a3632015-12-08 21:00:23 +08004380 or "reqadd" rules. That way, headers added by "add-header"/"set-header" are
4381 visible by almost all further ACL rules.
4382
4383 Using "reqadd"/"reqdel"/"reqrep" to manipulate request headers is discouraged
4384 in newer versions (>= 1.5). But if you need to use regular expression to
4385 delete headers, you can still use "reqdel". Also please use
4386 "http-request deny/allow/tarpit" instead of "reqdeny"/"reqpass"/"reqtarpit".
Krzysztof Piotr Oledzki6b35ce12010-02-01 23:35:44 +01004387
4388 Example:
Cyril Bonté78caf842010-03-10 22:41:43 +01004389 acl nagios src 192.168.129.3
4390 acl local_net src 192.168.0.0/16
4391 acl auth_ok http_auth(L1)
Krzysztof Piotr Oledzki6b35ce12010-02-01 23:35:44 +01004392
Cyril Bonté78caf842010-03-10 22:41:43 +01004393 http-request allow if nagios
4394 http-request allow if local_net auth_ok
4395 http-request auth realm Gimme if local_net auth_ok
4396 http-request deny
Krzysztof Piotr Oledzki6b35ce12010-02-01 23:35:44 +01004397
Cyril Bonté78caf842010-03-10 22:41:43 +01004398 Example:
4399 acl auth_ok http_auth_group(L1) G1
Cyril Bonté78caf842010-03-10 22:41:43 +01004400 http-request auth unless auth_ok
Krzysztof Piotr Oledzki6b35ce12010-02-01 23:35:44 +01004401
Willy Tarreau20b0de52012-12-24 15:45:22 +01004402 Example:
4403 http-request set-header X-Haproxy-Current-Date %T
4404 http-request set-header X-SSL %[ssl_fc]
Willy Tarreaufca42612015-08-27 17:15:05 +02004405 http-request set-header X-SSL-Session_ID %[ssl_fc_session_id,hex]
Willy Tarreau20b0de52012-12-24 15:45:22 +01004406 http-request set-header X-SSL-Client-Verify %[ssl_c_verify]
4407 http-request set-header X-SSL-Client-DN %{+Q}[ssl_c_s_dn]
4408 http-request set-header X-SSL-Client-CN %{+Q}[ssl_c_s_dn(cn)]
4409 http-request set-header X-SSL-Issuer %{+Q}[ssl_c_i_dn]
4410 http-request set-header X-SSL-Client-NotBefore %{+Q}[ssl_c_notbefore]
4411 http-request set-header X-SSL-Client-NotAfter %{+Q}[ssl_c_notafter]
4412
Baptiste Assmannfabcbe02014-04-24 22:16:59 +02004413 Example:
4414 acl key req.hdr(X-Add-Acl-Key) -m found
4415 acl add path /addacl
4416 acl del path /delacl
4417
4418 acl myhost hdr(Host) -f myhost.lst
4419
4420 http-request add-acl(myhost.lst) %[req.hdr(X-Add-Acl-Key)] if key add
4421 http-request del-acl(myhost.lst) %[req.hdr(X-Add-Acl-Key)] if key del
4422
4423 Example:
4424 acl value req.hdr(X-Value) -m found
4425 acl setmap path /setmap
4426 acl delmap path /delmap
4427
4428 use_backend bk_appli if { hdr(Host),map_str(map.lst) -m found }
4429
4430 http-request set-map(map.lst) %[src] %[req.hdr(X-Value)] if setmap value
4431 http-request del-map(map.lst) %[src] if delmap
4432
Cyril Bonté2be1b3f2010-09-30 23:46:30 +02004433 See also : "stats http-request", section 3.4 about userlists and section 7
4434 about ACL usage.
Willy Tarreauef781042010-01-27 11:53:01 +01004435
Willy Tarreauf4c43c12013-06-11 17:01:13 +02004436http-response { allow | deny | add-header <name> <fmt> | set-nice <nice> |
Willy Tarreau51d861a2015-05-22 17:30:48 +02004437 capture <sample> id <id> | redirect <rule> |
Thierry FOURNIERdad3d1d2014-04-22 18:07:25 +02004438 set-header <name> <fmt> | del-header <name> |
Sasha Pachev218f0642014-06-16 12:05:59 -06004439 replace-header <name> <regex-match> <replace-fmt> |
4440 replace-value <name> <regex-match> <replace-fmt> |
Robin H. Johnson52f5db22017-01-01 13:10:52 -08004441 set-status <status> [reason <str>] |
Baptiste Assmannfabcbe02014-04-24 22:16:59 +02004442 set-log-level <level> | set-mark <mark> | set-tos <tos> |
4443 add-acl(<file name>) <key fmt> |
4444 del-acl(<file name>) <key fmt> |
4445 del-map(<file name>) <key fmt> |
Thierry FOURNIER90da1912015-03-05 11:17:06 +01004446 set-map(<file name>) <key fmt> <value fmt> |
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02004447 set-var(<var-name>) <expr> |
Christopher Faulet85d79c92016-11-09 16:54:56 +01004448 unset-var(<var-name>) |
Ruoshan Huange4edc6b2016-07-14 15:07:45 +08004449 { track-sc0 | track-sc1 | track-sc2 } <key> [table <table>] |
Thierry FOURNIERe0627bd2015-08-04 08:20:33 +02004450 sc-inc-gpc0(<sc-id>) |
Frédéric Lécaille6778b272018-01-29 15:22:53 +01004451 sc-inc-gpc1(<sc-id>) |
Thierry FOURNIER236657b2015-08-19 08:25:14 +02004452 sc-set-gpt0(<sc-id>) <int> |
Willy Tarreau2d392c22015-08-24 01:43:45 +02004453 silent-drop |
William Lallemand86d0df02017-11-24 21:36:45 +01004454 send-spoe-group |
4455 cache-store
Baptiste Assmannfabcbe02014-04-24 22:16:59 +02004456 }
Lukas Tribus2dd1d1a2013-06-19 23:34:41 +02004457 [ { if | unless } <condition> ]
Willy Tarreaue365c0b2013-06-11 16:06:12 +02004458 Access control for Layer 7 responses
4459
4460 May be used in sections: defaults | frontend | listen | backend
4461 no | yes | yes | yes
4462
4463 The http-response statement defines a set of rules which apply to layer 7
4464 processing. The rules are evaluated in their declaration order when they are
4465 met in a frontend, listen or backend section. Any rule may optionally be
4466 followed by an ACL-based condition, in which case it will only be evaluated
4467 if the condition is true. Since these rules apply on responses, the backend
4468 rules are applied first, followed by the frontend's rules.
4469
4470 The first keyword is the rule's action. Currently supported actions include :
4471 - "allow" : this stops the evaluation of the rules and lets the response
4472 pass the check. No further "http-response" rules are evaluated for the
4473 current section.
4474
4475 - "deny" : this stops the evaluation of the rules and immediately rejects
4476 the response and emits an HTTP 502 error. No further "http-response"
4477 rules are evaluated.
4478
4479 - "add-header" appends an HTTP header field whose name is specified in
4480 <name> and whose value is defined by <fmt> which follows the log-format
4481 rules (see Custom Log Format in section 8.2.4). This may be used to send
4482 a cookie to a client for example, or to pass some internal information.
4483 This rule is not final, so it is possible to add other similar rules.
4484 Note that header addition is performed immediately, so one rule might
4485 reuse the resulting header from a previous rule.
4486
4487 - "set-header" does the same as "add-header" except that the header name
4488 is first removed if it existed. This is useful when passing security
4489 information to the server, where the header must not be manipulated by
4490 external users.
4491
Thierry FOURNIERdad3d1d2014-04-22 18:07:25 +02004492 - "del-header" removes all HTTP header fields whose name is specified in
4493 <name>.
4494
Sasha Pachev218f0642014-06-16 12:05:59 -06004495 - "replace-header" matches the regular expression in all occurrences of
4496 header field <name> according to <match-regex>, and replaces them with
4497 the <replace-fmt> argument. Format characters are allowed in replace-fmt
4498 and work like in <fmt> arguments in "add-header". The match is only
4499 case-sensitive. It is important to understand that this action only
4500 considers whole header lines, regardless of the number of values they
4501 may contain. This usage is suited to headers naturally containing commas
4502 in their value, such as Set-Cookie, Expires and so on.
4503
4504 Example:
4505
4506 http-response replace-header Set-Cookie (C=[^;]*);(.*) \1;ip=%bi;\2
4507
4508 applied to:
4509
4510 Set-Cookie: C=1; expires=Tue, 14-Jun-2016 01:40:45 GMT
4511
4512 outputs:
4513
4514 Set-Cookie: C=1;ip=192.168.1.20; expires=Tue, 14-Jun-2016 01:40:45 GMT
4515
4516 assuming the backend IP is 192.168.1.20.
4517
4518 - "replace-value" works like "replace-header" except that it matches the
4519 regex against every comma-delimited value of the header field <name>
4520 instead of the entire header. This is suited for all headers which are
4521 allowed to carry more than one value. An example could be the Accept
4522 header.
4523
4524 Example:
4525
4526 http-response replace-value Cache-control ^public$ private
4527
4528 applied to:
4529
4530 Cache-Control: max-age=3600, public
4531
4532 outputs:
4533
4534 Cache-Control: max-age=3600, private
4535
Thierry FOURNIER35d70ef2015-08-26 16:21:56 +02004536 - "set-status" replaces the response status code with <status> which must
Robin H. Johnson52f5db22017-01-01 13:10:52 -08004537 be an integer between 100 and 999. Optionally, a custom reason text can be
4538 provided defined by <str>, or the default reason for the specified code
4539 will be used as a fallback.
Thierry FOURNIER35d70ef2015-08-26 16:21:56 +02004540
4541 Example:
4542
4543 # return "431 Request Header Fields Too Large"
4544 http-response set-status 431
Robin H. Johnson52f5db22017-01-01 13:10:52 -08004545 # return "503 Slow Down", custom reason
4546 http-response set-status 503 reason "Slow Down".
Thierry FOURNIER35d70ef2015-08-26 16:21:56 +02004547
Willy Tarreauf4c43c12013-06-11 17:01:13 +02004548 - "set-nice" sets the "nice" factor of the current request being processed.
4549 It only has effect against the other requests being processed at the same
4550 time. The default value is 0, unless altered by the "nice" setting on the
4551 "bind" line. The accepted range is -1024..1024. The higher the value, the
4552 nicest the request will be. Lower values will make the request more
4553 important than other ones. This can be useful to improve the speed of
4554 some requests, or lower the priority of non-important requests. Using
4555 this setting without prior experimentation can cause some major slowdown.
4556
Willy Tarreau9a355ec2013-06-11 17:45:46 +02004557 - "set-log-level" is used to change the log level of the current request
4558 when a certain condition is met. Valid levels are the 8 syslog levels
4559 (see the "log" keyword) plus the special level "silent" which disables
4560 logging for this request. This rule is not final so the last matching
4561 rule wins. This rule can be useful to disable health checks coming from
4562 another equipment.
4563
Willy Tarreau42cf39e2013-06-11 18:51:32 +02004564 - "set-tos" is used to set the TOS or DSCP field value of packets sent to
4565 the client to the value passed in <tos> on platforms which support this.
4566 This value represents the whole 8 bits of the IP TOS field, and can be
4567 expressed both in decimal or hexadecimal format (prefixed by "0x"). Note
4568 that only the 6 higher bits are used in DSCP or TOS, and the two lower
Davor Ocelice9ed2812017-12-25 17:49:28 +01004569 bits are always 0. This can be used to adjust some routing behavior on
Willy Tarreau42cf39e2013-06-11 18:51:32 +02004570 border routers based on some information from the request. See RFC 2474,
4571 2597, 3260 and 4594 for more information.
4572
Willy Tarreau51347ed2013-06-11 19:34:13 +02004573 - "set-mark" is used to set the Netfilter MARK on all packets sent to the
4574 client to the value passed in <mark> on platforms which support it. This
4575 value is an unsigned 32 bit value which can be matched by netfilter and
4576 by the routing table. It can be expressed both in decimal or hexadecimal
4577 format (prefixed by "0x"). This can be useful to force certain packets to
4578 take a different route (for example a cheaper network path for bulk
4579 downloads). This works on Linux kernels 2.6.32 and above and requires
4580 admin privileges.
4581
Baptiste Assmannfabcbe02014-04-24 22:16:59 +02004582 - "add-acl" is used to add a new entry into an ACL. The ACL must be loaded
4583 from a file (even a dummy empty file). The file name of the ACL to be
4584 updated is passed between parentheses. It takes one argument: <key fmt>,
4585 which follows log-format rules, to collect content of the new entry. It
4586 performs a lookup in the ACL before insertion, to avoid duplicated (or
4587 more) values. This lookup is done by a linear search and can be expensive
4588 with large lists! It is the equivalent of the "add acl" command from the
4589 stats socket, but can be triggered by an HTTP response.
4590
4591 - "del-acl" is used to delete an entry from an ACL. The ACL must be loaded
4592 from a file (even a dummy empty file). The file name of the ACL to be
4593 updated is passed between parentheses. It takes one argument: <key fmt>,
4594 which follows log-format rules, to collect content of the entry to delete.
4595 It is the equivalent of the "del acl" command from the stats socket, but
4596 can be triggered by an HTTP response.
4597
4598 - "del-map" is used to delete an entry from a MAP. The MAP must be loaded
4599 from a file (even a dummy empty file). The file name of the MAP to be
4600 updated is passed between parentheses. It takes one argument: <key fmt>,
4601 which follows log-format rules, to collect content of the entry to delete.
4602 It takes one argument: "file name" It is the equivalent of the "del map"
4603 command from the stats socket, but can be triggered by an HTTP response.
4604
4605 - "set-map" is used to add a new entry into a MAP. The MAP must be loaded
4606 from a file (even a dummy empty file). The file name of the MAP to be
4607 updated is passed between parentheses. It takes 2 arguments: <key fmt>,
4608 which follows log-format rules, used to collect MAP key, and <value fmt>,
4609 which follows log-format rules, used to collect content for the new entry.
4610 It performs a lookup in the MAP before insertion, to avoid duplicated (or
4611 more) values. This lookup is done by a linear search and can be expensive
4612 with large lists! It is the equivalent of the "set map" command from the
4613 stats socket, but can be triggered by an HTTP response.
4614
Thierry FOURNIERe80fada2015-05-26 18:06:31 +02004615 - capture <sample> id <id> :
4616 captures sample expression <sample> from the response buffer, and converts
4617 it to a string. The resulting string is stored into the next request
4618 "capture" slot, so it will possibly appear next to some captured HTTP
4619 headers. It will then automatically appear in the logs, and it will be
4620 possible to extract it using sample fetch rules to feed it into headers or
4621 anything. Please check section 7.3 (Fetching samples) and "capture
4622 response header" for more information.
4623
4624 The keyword "id" is the id of the capture slot which is used for storing
4625 the string. The capture slot must be defined in an associated frontend.
4626 This is useful to run captures in backends. The slot id can be declared by
4627 a previous directive "http-response capture" or with the "declare capture"
4628 keyword.
Baptiste Assmanne9544932015-11-03 23:31:35 +01004629 If the slot <id> doesn't exist, then HAProxy fails parsing the
4630 configuration to prevent unexpected behavior at run time.
Thierry FOURNIERe80fada2015-05-26 18:06:31 +02004631
William Lallemand86d0df02017-11-24 21:36:45 +01004632 - cache-store <name> :
4633 See section 10.2 about cache setup.
4634
Willy Tarreau51d861a2015-05-22 17:30:48 +02004635 - "redirect" : this performs an HTTP redirection based on a redirect rule.
4636 This supports a format string similarly to "http-request redirect" rules,
4637 with the exception that only the "location" type of redirect is possible
4638 on the response. See the "redirect" keyword for the rule's syntax. When
4639 a redirect rule is applied during a response, connections to the server
4640 are closed so that no data can be forwarded from the server to the client.
4641
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02004642 - set-var(<var-name>) expr:
4643 Is used to set the contents of a variable. The variable is declared
4644 inline.
4645
Daniel Schneller0b547052016-03-21 20:46:57 +01004646 <var-name> The name of the variable starts with an indication about
4647 its scope. The scopes allowed are:
Christopher Fauletff2613e2016-11-09 11:36:17 +01004648 "proc" : the variable is shared with the whole process
Daniel Schneller0b547052016-03-21 20:46:57 +01004649 "sess" : the variable is shared with the whole session
4650 "txn" : the variable is shared with the transaction
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02004651 (request and response)
Daniel Schneller0b547052016-03-21 20:46:57 +01004652 "req" : the variable is shared only during request
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02004653 processing
Daniel Schneller0b547052016-03-21 20:46:57 +01004654 "res" : the variable is shared only during response
4655 processing
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02004656 This prefix is followed by a name. The separator is a '.'.
Christopher Fauletb71557a2016-10-31 10:49:03 +01004657 The name may only contain characters 'a-z', 'A-Z', '0-9',
4658 '.' and '_'.
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02004659
4660 <expr> Is a standard HAProxy expression formed by a sample-fetch
4661 followed by some converters.
4662
4663 Example:
4664
4665 http-response set-var(sess.last_redir) res.hdr(location)
4666
Christopher Faulet85d79c92016-11-09 16:54:56 +01004667 - unset-var(<var-name>) :
4668 Is used to unset a variable. See above for details about <var-name>.
4669
4670 Example:
4671
4672 http-response unset-var(sess.last_redir)
4673
Ruoshan Huange4edc6b2016-07-14 15:07:45 +08004674 - { track-sc0 | track-sc1 | track-sc2 } <key> [table <table>] :
4675 enables tracking of sticky counters from current response. Please refer to
4676 "http-request track-sc" for a complete description. The only difference
4677 from "http-request track-sc" is the <key> sample expression can only make
Davor Ocelice9ed2812017-12-25 17:49:28 +01004678 use of samples in response (e.g. res.*, status etc.) and samples below
4679 Layer 6 (e.g. SSL-related samples, see section 7.3.4). If the sample is
Ruoshan Huange4edc6b2016-07-14 15:07:45 +08004680 not supported, haproxy will fail and warn while parsing the config.
4681
Thierry FOURNIER236657b2015-08-19 08:25:14 +02004682 - sc-set-gpt0(<sc-id>) <int> :
4683 This action sets the GPT0 tag according to the sticky counter designated
4684 by <sc-id> and the value of <int>. The expected result is a boolean. If
4685 an error occurs, this action silently fails and the actions evaluation
4686 continues.
4687
Thierry FOURNIERe0627bd2015-08-04 08:20:33 +02004688 - sc-inc-gpc0(<sc-id>):
4689 This action increments the GPC0 counter according with the sticky counter
4690 designated by <sc-id>. If an error occurs, this action silently fails and
4691 the actions evaluation continues.
4692
Frédéric Lécaille6778b272018-01-29 15:22:53 +01004693 - sc-inc-gpc1(<sc-id>):
4694 Same as "sc-inc-gpc0" action above but for GPC1 counter.
4695
Willy Tarreau2d392c22015-08-24 01:43:45 +02004696 - "silent-drop" : this stops the evaluation of the rules and makes the
Davor Ocelice9ed2812017-12-25 17:49:28 +01004697 client-facing connection suddenly disappear using a system-dependent way
Willy Tarreau2d392c22015-08-24 01:43:45 +02004698 that tries to prevent the client from being notified. The effect it then
4699 that the client still sees an established connection while there's none
4700 on HAProxy. The purpose is to achieve a comparable effect to "tarpit"
4701 except that it doesn't use any local resource at all on the machine
4702 running HAProxy. It can resist much higher loads than "tarpit", and slow
Davor Ocelice9ed2812017-12-25 17:49:28 +01004703 down stronger attackers. It is important to understand the impact of using
4704 this mechanism. All stateful equipment placed between the client and
Willy Tarreau2d392c22015-08-24 01:43:45 +02004705 HAProxy (firewalls, proxies, load balancers) will also keep the
4706 established connection for a long time and may suffer from this action.
4707 On modern Linux systems running with enough privileges, the TCP_REPAIR
4708 socket option is used to block the emission of a TCP reset. On other
4709 systems, the socket's TTL is reduced to 1 so that the TCP reset doesn't
4710 pass the first router, though it's still delivered to local networks. Do
4711 not use it unless you fully understand how it works.
4712
Christopher Faulet76c09ef2017-09-21 11:03:52 +02004713 - send-spoe-group <engine-name> <group-name> :
4714 This action is used to trigger sending of a group of SPOE messages. To do
4715 so, the SPOE engine used to send messages must be defined, as well as the
4716 SPOE group to send. Of course, the SPOE engine must refer to an existing
4717 SPOE filter. If not engine name is provided on the SPOE filter line, the
4718 SPOE agent name must be used.
4719
4720 <engine-name> The SPOE engine name.
4721
4722 <group-name> The SPOE group name as specified in the engine
4723 configuration.
4724
Willy Tarreaue365c0b2013-06-11 16:06:12 +02004725 There is no limit to the number of http-response statements per instance.
4726
Godbach09250262013-07-02 01:19:15 +08004727 It is important to know that http-response rules are processed very early in
Ruoshan Huangeb5a3632015-12-08 21:00:23 +08004728 the HTTP processing, before "rspdel" or "rsprep" or "rspadd" rules. That way,
Davor Ocelice9ed2812017-12-25 17:49:28 +01004729 headers added by "add-header"/"set-header" are visible by almost all further
4730 ACL rules.
Willy Tarreaue365c0b2013-06-11 16:06:12 +02004731
Ruoshan Huangeb5a3632015-12-08 21:00:23 +08004732 Using "rspadd"/"rspdel"/"rsprep" to manipulate request headers is discouraged
4733 in newer versions (>= 1.5). But if you need to use regular expression to
4734 delete headers, you can still use "rspdel". Also please use
4735 "http-response deny" instead of "rspdeny".
4736
Baptiste Assmannfabcbe02014-04-24 22:16:59 +02004737 Example:
4738 acl key_acl res.hdr(X-Acl-Key) -m found
4739
4740 acl myhost hdr(Host) -f myhost.lst
4741
4742 http-response add-acl(myhost.lst) %[res.hdr(X-Acl-Key)] if key_acl
4743 http-response del-acl(myhost.lst) %[res.hdr(X-Acl-Key)] if key_acl
4744
4745 Example:
4746 acl value res.hdr(X-Value) -m found
4747
4748 use_backend bk_appli if { hdr(Host),map_str(map.lst) -m found }
4749
4750 http-response set-map(map.lst) %[src] %[res.hdr(X-Value)] if value
4751 http-response del-map(map.lst) %[src] if ! value
4752
Willy Tarreaue365c0b2013-06-11 16:06:12 +02004753 See also : "http-request", section 3.4 about userlists and section 7 about
4754 ACL usage.
4755
Baptiste Assmann5ecb77f2013-10-06 23:24:13 +02004756
Willy Tarreau30631952015-08-06 15:05:24 +02004757http-reuse { never | safe | aggressive | always }
4758 Declare how idle HTTP connections may be shared between requests
4759
4760 May be used in sections: defaults | frontend | listen | backend
4761 yes | no | yes | yes
4762
4763 By default, a connection established between haproxy and the backend server
4764 belongs to the session that initiated it. The downside is that between the
4765 response and the next request, the connection remains idle and is not used.
4766 In many cases for performance reasons it is desirable to make it possible to
4767 reuse these idle connections to serve other requests from different sessions.
Davor Ocelice9ed2812017-12-25 17:49:28 +01004768 This directive allows to tune this behavior.
Willy Tarreau30631952015-08-06 15:05:24 +02004769
4770 The argument indicates the desired connection reuse strategy :
4771
4772 - "never" : idle connections are never shared between sessions. This is
4773 the default choice. It may be enforced to cancel a different
4774 strategy inherited from a defaults section or for
4775 troubleshooting. For example, if an old bogus application
4776 considers that multiple requests over the same connection come
4777 from the same client and it is not possible to fix the
4778 application, it may be desirable to disable connection sharing
4779 in a single backend. An example of such an application could
4780 be an old haproxy using cookie insertion in tunnel mode and
4781 not checking any request past the first one.
4782
4783 - "safe" : this is the recommended strategy. The first request of a
4784 session is always sent over its own connection, and only
4785 subsequent requests may be dispatched over other existing
4786 connections. This ensures that in case the server closes the
4787 connection when the request is being sent, the browser can
4788 decide to silently retry it. Since it is exactly equivalent to
4789 regular keep-alive, there should be no side effects.
4790
4791 - "aggressive" : this mode may be useful in webservices environments where
4792 all servers are not necessarily known and where it would be
4793 appreciable to deliver most first requests over existing
4794 connections. In this case, first requests are only delivered
4795 over existing connections that have been reused at least once,
4796 proving that the server correctly supports connection reuse.
4797 It should only be used when it's sure that the client can
4798 retry a failed request once in a while and where the benefit
4799 of aggressive connection reuse significantly outweights the
4800 downsides of rare connection failures.
4801
4802 - "always" : this mode is only recommended when the path to the server is
4803 known for never breaking existing connections quickly after
4804 releasing them. It allows the first request of a session to be
4805 sent to an existing connection. This can provide a significant
4806 performance increase over the "safe" strategy when the backend
4807 is a cache farm, since such components tend to show a
Davor Ocelice9ed2812017-12-25 17:49:28 +01004808 consistent behavior and will benefit from the connection
Willy Tarreau30631952015-08-06 15:05:24 +02004809 sharing. It is recommended that the "http-keep-alive" timeout
4810 remains low in this mode so that no dead connections remain
4811 usable. In most cases, this will lead to the same performance
4812 gains as "aggressive" but with more risks. It should only be
4813 used when it improves the situation over "aggressive".
4814
4815 When http connection sharing is enabled, a great care is taken to respect the
Davor Ocelice9ed2812017-12-25 17:49:28 +01004816 connection properties and compatibility. Specifically :
4817 - connections made with "usesrc" followed by a client-dependent value
4818 ("client", "clientip", "hdr_ip") are marked private and never shared;
Willy Tarreau30631952015-08-06 15:05:24 +02004819
4820 - connections sent to a server with a TLS SNI extension are marked private
Davor Ocelice9ed2812017-12-25 17:49:28 +01004821 and are never shared;
Willy Tarreau30631952015-08-06 15:05:24 +02004822
4823 - connections receiving a status code 401 or 407 expect some authentication
4824 to be sent in return. Due to certain bogus authentication schemes (such
4825 as NTLM) relying on the connection, these connections are marked private
Davor Ocelice9ed2812017-12-25 17:49:28 +01004826 and are never shared;
Willy Tarreau30631952015-08-06 15:05:24 +02004827
4828 No connection pool is involved, once a session dies, the last idle connection
4829 it was attached to is deleted at the same time. This ensures that connections
4830 may not last after all sessions are closed.
4831
4832 Note: connection reuse improves the accuracy of the "server maxconn" setting,
4833 because almost no new connection will be established while idle connections
4834 remain available. This is particularly true with the "always" strategy.
4835
4836 See also : "option http-keep-alive", "server maxconn"
4837
4838
Mark Lamourinec2247f02012-01-04 13:02:01 -05004839http-send-name-header [<header>]
4840 Add the server name to a request. Use the header string given by <header>
4841
4842 May be used in sections: defaults | frontend | listen | backend
4843 yes | no | yes | yes
4844
4845 Arguments :
4846
4847 <header> The header string to use to send the server name
4848
4849 The "http-send-name-header" statement causes the name of the target
Davor Ocelice9ed2812017-12-25 17:49:28 +01004850 server to be added to the headers of an HTTP request. The name
Mark Lamourinec2247f02012-01-04 13:02:01 -05004851 is added with the header string proved.
4852
4853 See also : "server"
4854
Krzysztof Piotr Oledzkif58a9622008-02-23 01:19:10 +01004855id <value>
Willy Tarreau53fb4ae2009-10-04 23:04:08 +02004856 Set a persistent ID to a proxy.
4857 May be used in sections : defaults | frontend | listen | backend
4858 no | yes | yes | yes
4859 Arguments : none
4860
4861 Set a persistent ID for the proxy. This ID must be unique and positive.
4862 An unused ID will automatically be assigned if unset. The first assigned
4863 value will be 1. This ID is currently only returned in statistics.
Krzysztof Piotr Oledzkif58a9622008-02-23 01:19:10 +01004864
4865
Cyril Bonté0d4bf012010-04-25 23:21:46 +02004866ignore-persist { if | unless } <condition>
4867 Declare a condition to ignore persistence
4868 May be used in sections: defaults | frontend | listen | backend
Cyril Bonté4288c5a2018-03-12 22:02:59 +01004869 no | no | yes | yes
Cyril Bonté0d4bf012010-04-25 23:21:46 +02004870
4871 By default, when cookie persistence is enabled, every requests containing
4872 the cookie are unconditionally persistent (assuming the target server is up
4873 and running).
4874
4875 The "ignore-persist" statement allows one to declare various ACL-based
4876 conditions which, when met, will cause a request to ignore persistence.
4877 This is sometimes useful to load balance requests for static files, which
Jarno Huuskonen0e82b922014-04-12 18:22:19 +03004878 often don't require persistence. This can also be used to fully disable
Cyril Bonté0d4bf012010-04-25 23:21:46 +02004879 persistence for a specific User-Agent (for example, some web crawler bots).
4880
Cyril Bonté0d4bf012010-04-25 23:21:46 +02004881 The persistence is ignored when an "if" condition is met, or unless an
4882 "unless" condition is met.
4883
Jarno Huuskonene5ae7022017-04-03 14:36:21 +03004884 Example:
4885 acl url_static path_beg /static /images /img /css
4886 acl url_static path_end .gif .png .jpg .css .js
4887 ignore-persist if url_static
4888
Cyril Bonté0d4bf012010-04-25 23:21:46 +02004889 See also : "force-persist", "cookie", and section 7 about ACL usage.
4890
Baptiste Assmann01c6cc32015-08-23 11:45:29 +02004891load-server-state-from-file { global | local | none }
4892 Allow seamless reload of HAProxy
4893 May be used in sections: defaults | frontend | listen | backend
4894 yes | no | yes | yes
4895
4896 This directive points HAProxy to a file where server state from previous
4897 running process has been saved. That way, when starting up, before handling
4898 traffic, the new process can apply old states to servers exactly has if no
Davor Ocelice9ed2812017-12-25 17:49:28 +01004899 reload occurred. The purpose of the "load-server-state-from-file" directive is
Baptiste Assmann01c6cc32015-08-23 11:45:29 +02004900 to tell haproxy which file to use. For now, only 2 arguments to either prevent
4901 loading state or load states from a file containing all backends and servers.
4902 The state file can be generated by running the command "show servers state"
4903 over the stats socket and redirect output.
4904
Davor Ocelice9ed2812017-12-25 17:49:28 +01004905 The format of the file is versioned and is very specific. To understand it,
Baptiste Assmann01c6cc32015-08-23 11:45:29 +02004906 please read the documentation of the "show servers state" command (chapter
Willy Tarreau1af20c72017-06-23 16:01:14 +02004907 9.3 of Management Guide).
Baptiste Assmann01c6cc32015-08-23 11:45:29 +02004908
4909 Arguments:
4910 global load the content of the file pointed by the global directive
4911 named "server-state-file".
4912
4913 local load the content of the file pointed by the directive
4914 "server-state-file-name" if set. If not set, then the backend
4915 name is used as a file name.
4916
4917 none don't load any stat for this backend
4918
4919 Notes:
Willy Tarreaue5a60682016-11-09 14:54:53 +01004920 - server's IP address is preserved across reloads by default, but the
4921 order can be changed thanks to the server's "init-addr" setting. This
4922 means that an IP address change performed on the CLI at run time will
Davor Ocelice9ed2812017-12-25 17:49:28 +01004923 be preserved, and that any change to the local resolver (e.g. /etc/hosts)
Willy Tarreaue5a60682016-11-09 14:54:53 +01004924 will possibly not have any effect if the state file is in use.
Baptiste Assmann01c6cc32015-08-23 11:45:29 +02004925
4926 - server's weight is applied from previous running process unless it has
4927 has changed between previous and new configuration files.
4928
Olivier Doucetaa1ea8a2016-08-05 17:15:20 +02004929 Example: Minimal configuration
Baptiste Assmann01c6cc32015-08-23 11:45:29 +02004930
Olivier Doucetaa1ea8a2016-08-05 17:15:20 +02004931 global
4932 stats socket /tmp/socket
4933 server-state-file /tmp/server_state
Baptiste Assmann01c6cc32015-08-23 11:45:29 +02004934
Olivier Doucetaa1ea8a2016-08-05 17:15:20 +02004935 defaults
4936 load-server-state-from-file global
Baptiste Assmann01c6cc32015-08-23 11:45:29 +02004937
Olivier Doucetaa1ea8a2016-08-05 17:15:20 +02004938 backend bk
4939 server s1 127.0.0.1:22 check weight 11
4940 server s2 127.0.0.1:22 check weight 12
Baptiste Assmann01c6cc32015-08-23 11:45:29 +02004941
Baptiste Assmann01c6cc32015-08-23 11:45:29 +02004942
4943 Then one can run :
4944
4945 socat /tmp/socket - <<< "show servers state" > /tmp/server_state
4946
4947 Content of the file /tmp/server_state would be like this:
4948
4949 1
4950 # <field names skipped for the doc example>
4951 1 bk 1 s1 127.0.0.1 2 0 11 11 4 6 3 4 6 0 0
4952 1 bk 2 s2 127.0.0.1 2 0 12 12 4 6 3 4 6 0 0
4953
Olivier Doucetaa1ea8a2016-08-05 17:15:20 +02004954 Example: Minimal configuration
Baptiste Assmann01c6cc32015-08-23 11:45:29 +02004955
4956 global
4957 stats socket /tmp/socket
4958 server-state-base /etc/haproxy/states
4959
4960 defaults
4961 load-server-state-from-file local
4962
4963 backend bk
4964 server s1 127.0.0.1:22 check weight 11
4965 server s2 127.0.0.1:22 check weight 12
4966
Olivier Doucetaa1ea8a2016-08-05 17:15:20 +02004967
Baptiste Assmann01c6cc32015-08-23 11:45:29 +02004968 Then one can run :
4969
4970 socat /tmp/socket - <<< "show servers state bk" > /etc/haproxy/states/bk
4971
4972 Content of the file /etc/haproxy/states/bk would be like this:
4973
4974 1
4975 # <field names skipped for the doc example>
4976 1 bk 1 s1 127.0.0.1 2 0 11 11 4 6 3 4 6 0 0
4977 1 bk 2 s2 127.0.0.1 2 0 12 12 4 6 3 4 6 0 0
4978
4979 See also: "server-state-file", "server-state-file-name", and
4980 "show servers state"
4981
Cyril Bonté0d4bf012010-04-25 23:21:46 +02004982
Willy Tarreau2769aa02007-12-27 18:26:09 +01004983log global
Willy Tarreau18324f52014-06-27 18:10:07 +02004984log <address> [len <length>] <facility> [<level> [<minlevel>]]
William Lallemand0f99e342011-10-12 17:50:54 +02004985no log
Willy Tarreau2769aa02007-12-27 18:26:09 +01004986 Enable per-instance logging of events and traffic.
4987 May be used in sections : defaults | frontend | listen | backend
4988 yes | yes | yes | yes
William Lallemand0f99e342011-10-12 17:50:54 +02004989
4990 Prefix :
4991 no should be used when the logger list must be flushed. For example,
4992 if you don't want to inherit from the default logger list. This
4993 prefix does not allow arguments.
4994
Willy Tarreau2769aa02007-12-27 18:26:09 +01004995 Arguments :
4996 global should be used when the instance's logging parameters are the
4997 same as the global ones. This is the most common usage. "global"
4998 replaces <address>, <facility> and <level> with those of the log
4999 entries found in the "global" section. Only one "log global"
5000 statement may be used per instance, and this form takes no other
5001 parameter.
5002
5003 <address> indicates where to send the logs. It takes the same format as
5004 for the "global" section's logs, and can be one of :
5005
5006 - An IPv4 address optionally followed by a colon (':') and a UDP
5007 port. If no port is specified, 514 is used by default (the
5008 standard syslog port).
5009
David du Colombier24bb5f52011-03-17 10:40:23 +01005010 - An IPv6 address followed by a colon (':') and optionally a UDP
5011 port. If no port is specified, 514 is used by default (the
5012 standard syslog port).
5013
Willy Tarreau2769aa02007-12-27 18:26:09 +01005014 - A filesystem path to a UNIX domain socket, keeping in mind
5015 considerations for chroot (be sure the path is accessible
5016 inside the chroot) and uid/gid (be sure the path is
Davor Ocelice9ed2812017-12-25 17:49:28 +01005017 appropriately writable).
Willy Tarreau2769aa02007-12-27 18:26:09 +01005018
William Lallemandb2f07452015-05-12 14:27:13 +02005019 You may want to reference some environment variables in the
5020 address parameter, see section 2.3 about environment variables.
Willy Tarreaudad36a32013-03-11 01:20:04 +01005021
Willy Tarreau18324f52014-06-27 18:10:07 +02005022 <length> is an optional maximum line length. Log lines larger than this
5023 value will be truncated before being sent. The reason is that
5024 syslog servers act differently on log line length. All servers
5025 support the default value of 1024, but some servers simply drop
5026 larger lines while others do log them. If a server supports long
5027 lines, it may make sense to set this value here in order to avoid
5028 truncating long lines. Similarly, if a server drops long lines,
5029 it is preferable to truncate them before sending them. Accepted
5030 values are 80 to 65535 inclusive. The default value of 1024 is
5031 generally fine for all standard usages. Some specific cases of
Davor Ocelice9ed2812017-12-25 17:49:28 +01005032 long captures or JSON-formatted logs may require larger values.
Willy Tarreau18324f52014-06-27 18:10:07 +02005033
Willy Tarreau2769aa02007-12-27 18:26:09 +01005034 <facility> must be one of the 24 standard syslog facilities :
5035
5036 kern user mail daemon auth syslog lpr news
5037 uucp cron auth2 ftp ntp audit alert cron2
5038 local0 local1 local2 local3 local4 local5 local6 local7
5039
5040 <level> is optional and can be specified to filter outgoing messages. By
5041 default, all messages are sent. If a level is specified, only
5042 messages with a severity at least as important as this level
Willy Tarreauf7edefa2009-05-10 17:20:05 +02005043 will be sent. An optional minimum level can be specified. If it
5044 is set, logs emitted with a more severe level than this one will
5045 be capped to this level. This is used to avoid sending "emerg"
5046 messages on all terminals on some default syslog configurations.
5047 Eight levels are known :
Willy Tarreau2769aa02007-12-27 18:26:09 +01005048
5049 emerg alert crit err warning notice info debug
5050
William Lallemand0f99e342011-10-12 17:50:54 +02005051 It is important to keep in mind that it is the frontend which decides what to
5052 log from a connection, and that in case of content switching, the log entries
5053 from the backend will be ignored. Connections are logged at level "info".
Willy Tarreaucc6c8912009-02-22 10:53:55 +01005054
5055 However, backend log declaration define how and where servers status changes
5056 will be logged. Level "notice" will be used to indicate a server going up,
5057 "warning" will be used for termination signals and definitive service
5058 termination, and "alert" will be used for when a server goes down.
5059
5060 Note : According to RFC3164, messages are truncated to 1024 bytes before
5061 being emitted.
Willy Tarreau2769aa02007-12-27 18:26:09 +01005062
5063 Example :
5064 log global
Willy Tarreauf7edefa2009-05-10 17:20:05 +02005065 log 127.0.0.1:514 local0 notice # only send important events
5066 log 127.0.0.1:514 local0 notice notice # same but limit output level
William Lallemandb2f07452015-05-12 14:27:13 +02005067 log "${LOCAL_SYSLOG}:514" local0 notice # send to local server
Willy Tarreaudad36a32013-03-11 01:20:04 +01005068
Willy Tarreau2769aa02007-12-27 18:26:09 +01005069
William Lallemand48940402012-01-30 16:47:22 +01005070log-format <string>
Willy Tarreaufb4e7ea2015-01-07 14:55:17 +01005071 Specifies the log format string to use for traffic logs
5072 May be used in sections: defaults | frontend | listen | backend
5073 yes | yes | yes | no
William Lallemand48940402012-01-30 16:47:22 +01005074
Willy Tarreaufb4e7ea2015-01-07 14:55:17 +01005075 This directive specifies the log format string that will be used for all logs
5076 resulting from traffic passing through the frontend using this line. If the
5077 directive is used in a defaults section, all subsequent frontends will use
5078 the same log format. Please see section 8.2.4 which covers the log format
5079 string in depth.
William Lallemand48940402012-01-30 16:47:22 +01005080
Guillaume de Lafond29f45602017-03-31 19:52:15 +02005081 "log-format" directive overrides previous "option tcplog", "log-format" and
5082 "option httplog" directives.
5083
Dragan Dosen7ad31542015-09-28 17:16:47 +02005084log-format-sd <string>
5085 Specifies the RFC5424 structured-data log format string
5086 May be used in sections: defaults | frontend | listen | backend
5087 yes | yes | yes | no
5088
5089 This directive specifies the RFC5424 structured-data log format string that
5090 will be used for all logs resulting from traffic passing through the frontend
5091 using this line. If the directive is used in a defaults section, all
5092 subsequent frontends will use the same log format. Please see section 8.2.4
5093 which covers the log format string in depth.
5094
5095 See https://tools.ietf.org/html/rfc5424#section-6.3 for more information
5096 about the RFC5424 structured-data part.
5097
5098 Note : This log format string will be used only for loggers that have set
5099 log format to "rfc5424".
5100
5101 Example :
5102 log-format-sd [exampleSDID@1234\ bytes=\"%B\"\ status=\"%ST\"]
5103
5104
Willy Tarreau094af4e2015-01-07 15:03:42 +01005105log-tag <string>
5106 Specifies the log tag to use for all outgoing logs
5107 May be used in sections: defaults | frontend | listen | backend
5108 yes | yes | yes | yes
5109
5110 Sets the tag field in the syslog header to this string. It defaults to the
5111 log-tag set in the global section, otherwise the program name as launched
5112 from the command line, which usually is "haproxy". Sometimes it can be useful
5113 to differentiate between multiple processes running on the same host, or to
5114 differentiate customer instances running in the same process. In the backend,
5115 logs about servers up/down will use this tag. As a hint, it can be convenient
5116 to set a log-tag related to a hosted customer in a defaults section then put
5117 all the frontends and backends for that customer, then start another customer
5118 in a new defaults section. See also the global "log-tag" directive.
Willy Tarreau2769aa02007-12-27 18:26:09 +01005119
Willy Tarreauc35362a2014-04-25 13:58:37 +02005120max-keep-alive-queue <value>
5121 Set the maximum server queue size for maintaining keep-alive connections
5122 May be used in sections: defaults | frontend | listen | backend
5123 yes | no | yes | yes
5124
5125 HTTP keep-alive tries to reuse the same server connection whenever possible,
5126 but sometimes it can be counter-productive, for example if a server has a lot
5127 of connections while other ones are idle. This is especially true for static
5128 servers.
5129
5130 The purpose of this setting is to set a threshold on the number of queued
5131 connections at which haproxy stops trying to reuse the same server and prefers
5132 to find another one. The default value, -1, means there is no limit. A value
5133 of zero means that keep-alive requests will never be queued. For very close
5134 servers which can be reached with a low latency and which are not sensible to
Davor Ocelice9ed2812017-12-25 17:49:28 +01005135 breaking keep-alive, a low value is recommended (e.g. local static server can
Willy Tarreauc35362a2014-04-25 13:58:37 +02005136 use a value of 10 or less). For remote servers suffering from a high latency,
5137 higher values might be needed to cover for the latency and/or the cost of
5138 picking a different server.
5139
5140 Note that this has no impact on responses which are maintained to the same
5141 server consecutively to a 401 response. They will still go to the same server
5142 even if they have to be queued.
5143
5144 See also : "option http-server-close", "option prefer-last-server", server
5145 "maxconn" and cookie persistence.
5146
5147
Willy Tarreau2769aa02007-12-27 18:26:09 +01005148maxconn <conns>
5149 Fix the maximum number of concurrent connections on a frontend
5150 May be used in sections : defaults | frontend | listen | backend
5151 yes | yes | yes | no
5152 Arguments :
5153 <conns> is the maximum number of concurrent connections the frontend will
5154 accept to serve. Excess connections will be queued by the system
5155 in the socket's listen queue and will be served once a connection
5156 closes.
5157
5158 If the system supports it, it can be useful on big sites to raise this limit
5159 very high so that haproxy manages connection queues, instead of leaving the
5160 clients with unanswered connection attempts. This value should not exceed the
5161 global maxconn. Also, keep in mind that a connection contains two buffers
Baptiste Assmann79fb45d2016-03-06 23:34:31 +01005162 of tune.bufsize (16kB by default) each, as well as some other data resulting
5163 in about 33 kB of RAM being consumed per established connection. That means
5164 that a medium system equipped with 1GB of RAM can withstand around
5165 20000-25000 concurrent connections if properly tuned.
Willy Tarreau2769aa02007-12-27 18:26:09 +01005166
5167 Also, when <conns> is set to large values, it is possible that the servers
5168 are not sized to accept such loads, and for this reason it is generally wise
5169 to assign them some reasonable connection limits.
5170
Vincent Bernat6341be52012-06-27 17:18:30 +02005171 By default, this value is set to 2000.
5172
Willy Tarreau2769aa02007-12-27 18:26:09 +01005173 See also : "server", global section's "maxconn", "fullconn"
5174
5175
5176mode { tcp|http|health }
5177 Set the running mode or protocol of the instance
5178 May be used in sections : defaults | frontend | listen | backend
5179 yes | yes | yes | yes
5180 Arguments :
5181 tcp The instance will work in pure TCP mode. A full-duplex connection
5182 will be established between clients and servers, and no layer 7
5183 examination will be performed. This is the default mode. It
5184 should be used for SSL, SSH, SMTP, ...
5185
5186 http The instance will work in HTTP mode. The client request will be
5187 analyzed in depth before connecting to any server. Any request
5188 which is not RFC-compliant will be rejected. Layer 7 filtering,
5189 processing and switching will be possible. This is the mode which
5190 brings HAProxy most of its value.
5191
5192 health The instance will work in "health" mode. It will just reply "OK"
Willy Tarreau82569f92012-09-27 23:48:56 +02005193 to incoming connections and close the connection. Alternatively,
5194 If the "httpchk" option is set, "HTTP/1.0 200 OK" will be sent
5195 instead. Nothing will be logged in either case. This mode is used
5196 to reply to external components health checks. This mode is
5197 deprecated and should not be used anymore as it is possible to do
5198 the same and even better by combining TCP or HTTP modes with the
5199 "monitor" keyword.
Willy Tarreau2769aa02007-12-27 18:26:09 +01005200
Cyril Bonté108cf6e2012-04-21 23:30:29 +02005201 When doing content switching, it is mandatory that the frontend and the
5202 backend are in the same mode (generally HTTP), otherwise the configuration
5203 will be refused.
Willy Tarreau2769aa02007-12-27 18:26:09 +01005204
Cyril Bonté108cf6e2012-04-21 23:30:29 +02005205 Example :
Willy Tarreau2769aa02007-12-27 18:26:09 +01005206 defaults http_instances
5207 mode http
5208
Cyril Bonté108cf6e2012-04-21 23:30:29 +02005209 See also : "monitor", "monitor-net"
Willy Tarreau2769aa02007-12-27 18:26:09 +01005210
Willy Tarreau0ba27502007-12-24 16:55:16 +01005211
Cyril Bontéf0c60612010-02-06 14:44:47 +01005212monitor fail { if | unless } <condition>
Willy Tarreau2769aa02007-12-27 18:26:09 +01005213 Add a condition to report a failure to a monitor HTTP request.
Willy Tarreau0ba27502007-12-24 16:55:16 +01005214 May be used in sections : defaults | frontend | listen | backend
5215 no | yes | yes | no
Willy Tarreau0ba27502007-12-24 16:55:16 +01005216 Arguments :
5217 if <cond> the monitor request will fail if the condition is satisfied,
5218 and will succeed otherwise. The condition should describe a
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +01005219 combined test which must induce a failure if all conditions
Willy Tarreau0ba27502007-12-24 16:55:16 +01005220 are met, for instance a low number of servers both in a
5221 backend and its backup.
5222
5223 unless <cond> the monitor request will succeed only if the condition is
5224 satisfied, and will fail otherwise. Such a condition may be
5225 based on a test on the presence of a minimum number of active
5226 servers in a list of backends.
5227
5228 This statement adds a condition which can force the response to a monitor
5229 request to report a failure. By default, when an external component queries
5230 the URI dedicated to monitoring, a 200 response is returned. When one of the
5231 conditions above is met, haproxy will return 503 instead of 200. This is
5232 very useful to report a site failure to an external component which may base
5233 routing advertisements between multiple sites on the availability reported by
5234 haproxy. In this case, one would rely on an ACL involving the "nbsrv"
Willy Tarreauae94d4d2011-05-11 16:28:49 +02005235 criterion. Note that "monitor fail" only works in HTTP mode. Both status
5236 messages may be tweaked using "errorfile" or "errorloc" if needed.
Willy Tarreau0ba27502007-12-24 16:55:16 +01005237
5238 Example:
5239 frontend www
Willy Tarreau2769aa02007-12-27 18:26:09 +01005240 mode http
Willy Tarreau0ba27502007-12-24 16:55:16 +01005241 acl site_dead nbsrv(dynamic) lt 2
5242 acl site_dead nbsrv(static) lt 2
5243 monitor-uri /site_alive
5244 monitor fail if site_dead
5245
Willy Tarreauae94d4d2011-05-11 16:28:49 +02005246 See also : "monitor-net", "monitor-uri", "errorfile", "errorloc"
Willy Tarreau2769aa02007-12-27 18:26:09 +01005247
5248
5249monitor-net <source>
5250 Declare a source network which is limited to monitor requests
5251 May be used in sections : defaults | frontend | listen | backend
5252 yes | yes | yes | no
5253 Arguments :
5254 <source> is the source IPv4 address or network which will only be able to
5255 get monitor responses to any request. It can be either an IPv4
5256 address, a host name, or an address followed by a slash ('/')
5257 followed by a mask.
5258
5259 In TCP mode, any connection coming from a source matching <source> will cause
5260 the connection to be immediately closed without any log. This allows another
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +01005261 equipment to probe the port and verify that it is still listening, without
Willy Tarreau2769aa02007-12-27 18:26:09 +01005262 forwarding the connection to a remote server.
5263
5264 In HTTP mode, a connection coming from a source matching <source> will be
5265 accepted, the following response will be sent without waiting for a request,
5266 then the connection will be closed : "HTTP/1.0 200 OK". This is normally
5267 enough for any front-end HTTP probe to detect that the service is UP and
Willy Tarreau82569f92012-09-27 23:48:56 +02005268 running without forwarding the request to a backend server. Note that this
5269 response is sent in raw format, without any transformation. This is important
5270 as it means that it will not be SSL-encrypted on SSL listeners.
Willy Tarreau2769aa02007-12-27 18:26:09 +01005271
Willy Tarreau82569f92012-09-27 23:48:56 +02005272 Monitor requests are processed very early, just after tcp-request connection
5273 ACLs which are the only ones able to block them. These connections are short
5274 lived and never wait for any data from the client. They cannot be logged, and
5275 it is the intended purpose. They are only used to report HAProxy's health to
5276 an upper component, nothing more. Please note that "monitor fail" rules do
5277 not apply to connections intercepted by "monitor-net".
Willy Tarreau2769aa02007-12-27 18:26:09 +01005278
Willy Tarreau95cd2832010-03-04 23:36:33 +01005279 Last, please note that only one "monitor-net" statement can be specified in
5280 a frontend. If more than one is found, only the last one will be considered.
Cyril Bonté108cf6e2012-04-21 23:30:29 +02005281
Willy Tarreau2769aa02007-12-27 18:26:09 +01005282 Example :
5283 # addresses .252 and .253 are just probing us.
5284 frontend www
5285 monitor-net 192.168.0.252/31
5286
5287 See also : "monitor fail", "monitor-uri"
5288
5289
5290monitor-uri <uri>
5291 Intercept a URI used by external components' monitor requests
5292 May be used in sections : defaults | frontend | listen | backend
5293 yes | yes | yes | no
5294 Arguments :
5295 <uri> is the exact URI which we want to intercept to return HAProxy's
5296 health status instead of forwarding the request.
5297
5298 When an HTTP request referencing <uri> will be received on a frontend,
5299 HAProxy will not forward it nor log it, but instead will return either
5300 "HTTP/1.0 200 OK" or "HTTP/1.0 503 Service unavailable", depending on failure
5301 conditions defined with "monitor fail". This is normally enough for any
5302 front-end HTTP probe to detect that the service is UP and running without
5303 forwarding the request to a backend server. Note that the HTTP method, the
5304 version and all headers are ignored, but the request must at least be valid
5305 at the HTTP level. This keyword may only be used with an HTTP-mode frontend.
5306
Willy Tarreau721d8e02017-12-01 18:25:08 +01005307 Monitor requests are processed very early, just after the request is parsed
5308 and even before any "http-request" or "block" rulesets. The only rulesets
5309 applied before are the tcp-request ones. They cannot be logged either, and it
5310 is the intended purpose. They are only used to report HAProxy's health to an
5311 upper component, nothing more. However, it is possible to add any number of
5312 conditions using "monitor fail" and ACLs so that the result can be adjusted
5313 to whatever check can be imagined (most often the number of available servers
5314 in a backend).
Willy Tarreau2769aa02007-12-27 18:26:09 +01005315
5316 Example :
5317 # Use /haproxy_test to report haproxy's status
5318 frontend www
5319 mode http
5320 monitor-uri /haproxy_test
5321
5322 See also : "monitor fail", "monitor-net"
5323
Willy Tarreau0ba27502007-12-24 16:55:16 +01005324
Willy Tarreaubf1f8162007-12-28 17:42:56 +01005325option abortonclose
5326no option abortonclose
5327 Enable or disable early dropping of aborted requests pending in queues.
5328 May be used in sections : defaults | frontend | listen | backend
5329 yes | no | yes | yes
5330 Arguments : none
5331
5332 In presence of very high loads, the servers will take some time to respond.
5333 The per-instance connection queue will inflate, and the response time will
5334 increase respective to the size of the queue times the average per-session
5335 response time. When clients will wait for more than a few seconds, they will
Willy Tarreau198a7442008-01-17 12:05:32 +01005336 often hit the "STOP" button on their browser, leaving a useless request in
Willy Tarreaubf1f8162007-12-28 17:42:56 +01005337 the queue, and slowing down other users, and the servers as well, because the
5338 request will eventually be served, then aborted at the first error
5339 encountered while delivering the response.
5340
5341 As there is no way to distinguish between a full STOP and a simple output
5342 close on the client side, HTTP agents should be conservative and consider
5343 that the client might only have closed its output channel while waiting for
5344 the response. However, this introduces risks of congestion when lots of users
5345 do the same, and is completely useless nowadays because probably no client at
5346 all will close the session while waiting for the response. Some HTTP agents
Davor Ocelice9ed2812017-12-25 17:49:28 +01005347 support this behavior (Squid, Apache, HAProxy), and others do not (TUX, most
Willy Tarreaubf1f8162007-12-28 17:42:56 +01005348 hardware-based load balancers). So the probability for a closed input channel
Willy Tarreau198a7442008-01-17 12:05:32 +01005349 to represent a user hitting the "STOP" button is close to 100%, and the risk
Willy Tarreaubf1f8162007-12-28 17:42:56 +01005350 of being the single component to break rare but valid traffic is extremely
5351 low, which adds to the temptation to be able to abort a session early while
5352 still not served and not pollute the servers.
5353
Davor Ocelice9ed2812017-12-25 17:49:28 +01005354 In HAProxy, the user can choose the desired behavior using the option
5355 "abortonclose". By default (without the option) the behavior is HTTP
Willy Tarreaubf1f8162007-12-28 17:42:56 +01005356 compliant and aborted requests will be served. But when the option is
5357 specified, a session with an incoming channel closed will be aborted while
5358 it is still possible, either pending in the queue for a connection slot, or
5359 during the connection establishment if the server has not yet acknowledged
5360 the connection request. This considerably reduces the queue size and the load
5361 on saturated servers when users are tempted to click on STOP, which in turn
Willy Tarreaud72758d2010-01-12 10:42:19 +01005362 reduces the response time for other users.
Willy Tarreaubf1f8162007-12-28 17:42:56 +01005363
5364 If this option has been enabled in a "defaults" section, it can be disabled
5365 in a specific instance by prepending the "no" keyword before it.
5366
5367 See also : "timeout queue" and server's "maxconn" and "maxqueue" parameters
5368
5369
Willy Tarreau4076a152009-04-02 15:18:36 +02005370option accept-invalid-http-request
5371no option accept-invalid-http-request
5372 Enable or disable relaxing of HTTP request parsing
5373 May be used in sections : defaults | frontend | listen | backend
5374 yes | yes | yes | no
5375 Arguments : none
5376
Willy Tarreau91852eb2015-05-01 13:26:00 +02005377 By default, HAProxy complies with RFC7230 in terms of message parsing. This
Willy Tarreau4076a152009-04-02 15:18:36 +02005378 means that invalid characters in header names are not permitted and cause an
Davor Ocelice9ed2812017-12-25 17:49:28 +01005379 error to be returned to the client. This is the desired behavior as such
Willy Tarreau4076a152009-04-02 15:18:36 +02005380 forbidden characters are essentially used to build attacks exploiting server
5381 weaknesses, and bypass security filtering. Sometimes, a buggy browser or
5382 server will emit invalid header names for whatever reason (configuration,
5383 implementation) and the issue will not be immediately fixed. In such a case,
5384 it is possible to relax HAProxy's header name parser to accept any character
Willy Tarreau422246e2012-01-07 23:54:13 +01005385 even if that does not make sense, by specifying this option. Similarly, the
5386 list of characters allowed to appear in a URI is well defined by RFC3986, and
5387 chars 0-31, 32 (space), 34 ('"'), 60 ('<'), 62 ('>'), 92 ('\'), 94 ('^'), 96
5388 ('`'), 123 ('{'), 124 ('|'), 125 ('}'), 127 (delete) and anything above are
Davor Ocelice9ed2812017-12-25 17:49:28 +01005389 not allowed at all. HAProxy always blocks a number of them (0..32, 127). The
Willy Tarreau91852eb2015-05-01 13:26:00 +02005390 remaining ones are blocked by default unless this option is enabled. This
Willy Tarreau13317662015-05-01 13:47:08 +02005391 option also relaxes the test on the HTTP version, it allows HTTP/0.9 requests
5392 to pass through (no version specified) and multiple digits for both the major
5393 and the minor version.
Willy Tarreau4076a152009-04-02 15:18:36 +02005394
5395 This option should never be enabled by default as it hides application bugs
5396 and open security breaches. It should only be deployed after a problem has
5397 been confirmed.
5398
5399 When this option is enabled, erroneous header names will still be accepted in
5400 requests, but the complete request will be captured in order to permit later
Willy Tarreau422246e2012-01-07 23:54:13 +01005401 analysis using the "show errors" request on the UNIX stats socket. Similarly,
5402 requests containing invalid chars in the URI part will be logged. Doing this
Willy Tarreau4076a152009-04-02 15:18:36 +02005403 also helps confirming that the issue has been solved.
5404
5405 If this option has been enabled in a "defaults" section, it can be disabled
5406 in a specific instance by prepending the "no" keyword before it.
5407
5408 See also : "option accept-invalid-http-response" and "show errors" on the
5409 stats socket.
5410
5411
5412option accept-invalid-http-response
5413no option accept-invalid-http-response
5414 Enable or disable relaxing of HTTP response parsing
5415 May be used in sections : defaults | frontend | listen | backend
5416 yes | no | yes | yes
5417 Arguments : none
5418
Willy Tarreau91852eb2015-05-01 13:26:00 +02005419 By default, HAProxy complies with RFC7230 in terms of message parsing. This
Willy Tarreau4076a152009-04-02 15:18:36 +02005420 means that invalid characters in header names are not permitted and cause an
Davor Ocelice9ed2812017-12-25 17:49:28 +01005421 error to be returned to the client. This is the desired behavior as such
Willy Tarreau4076a152009-04-02 15:18:36 +02005422 forbidden characters are essentially used to build attacks exploiting server
5423 weaknesses, and bypass security filtering. Sometimes, a buggy browser or
5424 server will emit invalid header names for whatever reason (configuration,
5425 implementation) and the issue will not be immediately fixed. In such a case,
5426 it is possible to relax HAProxy's header name parser to accept any character
Willy Tarreau91852eb2015-05-01 13:26:00 +02005427 even if that does not make sense, by specifying this option. This option also
5428 relaxes the test on the HTTP version format, it allows multiple digits for
5429 both the major and the minor version.
Willy Tarreau4076a152009-04-02 15:18:36 +02005430
5431 This option should never be enabled by default as it hides application bugs
5432 and open security breaches. It should only be deployed after a problem has
5433 been confirmed.
5434
5435 When this option is enabled, erroneous header names will still be accepted in
5436 responses, but the complete response will be captured in order to permit
5437 later analysis using the "show errors" request on the UNIX stats socket.
5438 Doing this also helps confirming that the issue has been solved.
5439
5440 If this option has been enabled in a "defaults" section, it can be disabled
5441 in a specific instance by prepending the "no" keyword before it.
5442
5443 See also : "option accept-invalid-http-request" and "show errors" on the
5444 stats socket.
5445
5446
Willy Tarreaubf1f8162007-12-28 17:42:56 +01005447option allbackups
5448no option allbackups
5449 Use either all backup servers at a time or only the first one
5450 May be used in sections : defaults | frontend | listen | backend
5451 yes | no | yes | yes
5452 Arguments : none
5453
5454 By default, the first operational backup server gets all traffic when normal
5455 servers are all down. Sometimes, it may be preferred to use multiple backups
5456 at once, because one will not be enough. When "option allbackups" is enabled,
5457 the load balancing will be performed among all backup servers when all normal
5458 ones are unavailable. The same load balancing algorithm will be used and the
5459 servers' weights will be respected. Thus, there will not be any priority
5460 order between the backup servers anymore.
5461
5462 This option is mostly used with static server farms dedicated to return a
5463 "sorry" page when an application is completely offline.
5464
5465 If this option has been enabled in a "defaults" section, it can be disabled
5466 in a specific instance by prepending the "no" keyword before it.
5467
5468
5469option checkcache
5470no option checkcache
Godbach7056a352013-12-11 20:01:07 +08005471 Analyze all server responses and block responses with cacheable cookies
Willy Tarreaubf1f8162007-12-28 17:42:56 +01005472 May be used in sections : defaults | frontend | listen | backend
5473 yes | no | yes | yes
5474 Arguments : none
5475
5476 Some high-level frameworks set application cookies everywhere and do not
5477 always let enough control to the developer to manage how the responses should
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +01005478 be cached. When a session cookie is returned on a cacheable object, there is a
Willy Tarreaubf1f8162007-12-28 17:42:56 +01005479 high risk of session crossing or stealing between users traversing the same
5480 caches. In some situations, it is better to block the response than to let
Willy Tarreau3c92c5f2011-08-28 09:45:47 +02005481 some sensitive session information go in the wild.
Willy Tarreaubf1f8162007-12-28 17:42:56 +01005482
5483 The option "checkcache" enables deep inspection of all server responses for
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +01005484 strict compliance with HTTP specification in terms of cacheability. It
Willy Tarreau198a7442008-01-17 12:05:32 +01005485 carefully checks "Cache-control", "Pragma" and "Set-cookie" headers in server
Willy Tarreaubf1f8162007-12-28 17:42:56 +01005486 response to check if there's a risk of caching a cookie on a client-side
5487 proxy. When this option is enabled, the only responses which can be delivered
Willy Tarreau198a7442008-01-17 12:05:32 +01005488 to the client are :
Davor Ocelice9ed2812017-12-25 17:49:28 +01005489 - all those without "Set-Cookie" header;
Willy Tarreauc55ddce2017-12-21 11:41:38 +01005490 - all those with a return code other than 200, 203, 204, 206, 300, 301,
5491 404, 405, 410, 414, 501, provided that the server has not set a
Davor Ocelice9ed2812017-12-25 17:49:28 +01005492 "Cache-control: public" header field;
Willy Tarreau24ea0bc2017-12-21 11:32:55 +01005493 - all those that result from a request using a method other than GET, HEAD,
5494 OPTIONS, TRACE, provided that the server has not set a 'Cache-Control:
Davor Ocelice9ed2812017-12-25 17:49:28 +01005495 public' header field;
Willy Tarreaubf1f8162007-12-28 17:42:56 +01005496 - those with a 'Pragma: no-cache' header
5497 - those with a 'Cache-control: private' header
5498 - those with a 'Cache-control: no-store' header
5499 - those with a 'Cache-control: max-age=0' header
5500 - those with a 'Cache-control: s-maxage=0' header
5501 - those with a 'Cache-control: no-cache' header
5502 - those with a 'Cache-control: no-cache="set-cookie"' header
5503 - those with a 'Cache-control: no-cache="set-cookie,' header
5504 (allowing other fields after set-cookie)
5505
5506 If a response doesn't respect these requirements, then it will be blocked
Willy Tarreau198a7442008-01-17 12:05:32 +01005507 just as if it was from an "rspdeny" filter, with an "HTTP 502 bad gateway".
Willy Tarreaubf1f8162007-12-28 17:42:56 +01005508 The session state shows "PH--" meaning that the proxy blocked the response
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +01005509 during headers processing. Additionally, an alert will be sent in the logs so
Willy Tarreaubf1f8162007-12-28 17:42:56 +01005510 that admins are informed that there's something to be fixed.
5511
5512 Due to the high impact on the application, the application should be tested
5513 in depth with the option enabled before going to production. It is also a
Willy Tarreaud2a4aa22008-01-31 15:28:22 +01005514 good practice to always activate it during tests, even if it is not used in
Davor Ocelice9ed2812017-12-25 17:49:28 +01005515 production, as it will report potentially dangerous application behaviors.
Willy Tarreaubf1f8162007-12-28 17:42:56 +01005516
5517 If this option has been enabled in a "defaults" section, it can be disabled
5518 in a specific instance by prepending the "no" keyword before it.
5519
5520
5521option clitcpka
5522no option clitcpka
5523 Enable or disable the sending of TCP keepalive packets on the client side
5524 May be used in sections : defaults | frontend | listen | backend
5525 yes | yes | yes | no
5526 Arguments : none
5527
5528 When there is a firewall or any session-aware component between a client and
5529 a server, and when the protocol involves very long sessions with long idle
Davor Ocelice9ed2812017-12-25 17:49:28 +01005530 periods (e.g. remote desktops), there is a risk that one of the intermediate
Willy Tarreaubf1f8162007-12-28 17:42:56 +01005531 components decides to expire a session which has remained idle for too long.
5532
5533 Enabling socket-level TCP keep-alives makes the system regularly send packets
5534 to the other end of the connection, leaving it active. The delay between
5535 keep-alive probes is controlled by the system only and depends both on the
5536 operating system and its tuning parameters.
5537
5538 It is important to understand that keep-alive packets are neither emitted nor
5539 received at the application level. It is only the network stacks which sees
5540 them. For this reason, even if one side of the proxy already uses keep-alives
5541 to maintain its connection alive, those keep-alive packets will not be
5542 forwarded to the other side of the proxy.
5543
5544 Please note that this has nothing to do with HTTP keep-alive.
5545
5546 Using option "clitcpka" enables the emission of TCP keep-alive probes on the
5547 client side of a connection, which should help when session expirations are
5548 noticed between HAProxy and a client.
5549
5550 If this option has been enabled in a "defaults" section, it can be disabled
5551 in a specific instance by prepending the "no" keyword before it.
5552
5553 See also : "option srvtcpka", "option tcpka"
5554
5555
Willy Tarreau0ba27502007-12-24 16:55:16 +01005556option contstats
5557 Enable continuous traffic statistics updates
5558 May be used in sections : defaults | frontend | listen | backend
5559 yes | yes | yes | no
5560 Arguments : none
5561
5562 By default, counters used for statistics calculation are incremented
5563 only when a session finishes. It works quite well when serving small
5564 objects, but with big ones (for example large images or archives) or
5565 with A/V streaming, a graph generated from haproxy counters looks like
Willy Tarreaudef0d222016-11-08 22:03:00 +01005566 a hedgehog. With this option enabled counters get incremented frequently
5567 along the session, typically every 5 seconds, which is often enough to
5568 produce clean graphs. Recounting touches a hotpath directly so it is not
5569 not enabled by default, as it can cause a lot of wakeups for very large
5570 session counts and cause a small performance drop.
Willy Tarreau0ba27502007-12-24 16:55:16 +01005571
5572
Willy Tarreauc9bd0cc2009-05-10 11:57:02 +02005573option dontlog-normal
5574no option dontlog-normal
5575 Enable or disable logging of normal, successful connections
5576 May be used in sections : defaults | frontend | listen | backend
5577 yes | yes | yes | no
5578 Arguments : none
5579
5580 There are large sites dealing with several thousand connections per second
5581 and for which logging is a major pain. Some of them are even forced to turn
5582 logs off and cannot debug production issues. Setting this option ensures that
5583 normal connections, those which experience no error, no timeout, no retry nor
5584 redispatch, will not be logged. This leaves disk space for anomalies. In HTTP
5585 mode, the response status code is checked and return codes 5xx will still be
5586 logged.
5587
5588 It is strongly discouraged to use this option as most of the time, the key to
5589 complex issues is in the normal logs which will not be logged here. If you
5590 need to separate logs, see the "log-separate-errors" option instead.
5591
Willy Tarreauc57f0e22009-05-10 13:12:33 +02005592 See also : "log", "dontlognull", "log-separate-errors" and section 8 about
Willy Tarreauc9bd0cc2009-05-10 11:57:02 +02005593 logging.
5594
5595
Willy Tarreaubf1f8162007-12-28 17:42:56 +01005596option dontlognull
5597no option dontlognull
5598 Enable or disable logging of null connections
5599 May be used in sections : defaults | frontend | listen | backend
5600 yes | yes | yes | no
5601 Arguments : none
5602
5603 In certain environments, there are components which will regularly connect to
5604 various systems to ensure that they are still alive. It can be the case from
5605 another load balancer as well as from monitoring systems. By default, even a
5606 simple port probe or scan will produce a log. If those connections pollute
5607 the logs too much, it is possible to enable option "dontlognull" to indicate
5608 that a connection on which no data has been transferred will not be logged,
Willy Tarreau0f228a02015-05-01 15:37:53 +02005609 which typically corresponds to those probes. Note that errors will still be
5610 returned to the client and accounted for in the stats. If this is not what is
5611 desired, option http-ignore-probes can be used instead.
Willy Tarreaubf1f8162007-12-28 17:42:56 +01005612
5613 It is generally recommended not to use this option in uncontrolled
Davor Ocelice9ed2812017-12-25 17:49:28 +01005614 environments (e.g. internet), otherwise scans and other malicious activities
Willy Tarreaubf1f8162007-12-28 17:42:56 +01005615 would not be logged.
5616
5617 If this option has been enabled in a "defaults" section, it can be disabled
5618 in a specific instance by prepending the "no" keyword before it.
5619
Willy Tarreau0f228a02015-05-01 15:37:53 +02005620 See also : "log", "http-ignore-probes", "monitor-net", "monitor-uri", and
5621 section 8 about logging.
Willy Tarreaubf1f8162007-12-28 17:42:56 +01005622
5623
5624option forceclose
5625no option forceclose
5626 Enable or disable active connection closing after response is transferred.
5627 May be used in sections : defaults | frontend | listen | backend
Willy Tarreaua31e5df2009-12-30 01:10:35 +01005628 yes | yes | yes | yes
Willy Tarreaubf1f8162007-12-28 17:42:56 +01005629 Arguments : none
5630
5631 Some HTTP servers do not necessarily close the connections when they receive
5632 the "Connection: close" set by "option httpclose", and if the client does not
5633 close either, then the connection remains open till the timeout expires. This
5634 causes high number of simultaneous connections on the servers and shows high
5635 global session times in the logs.
5636
5637 When this happens, it is possible to use "option forceclose". It will
Willy Tarreau82eeaf22009-12-29 12:09:05 +01005638 actively close the outgoing server channel as soon as the server has finished
Cyril Bonté653dcd62014-02-20 00:13:15 +01005639 to respond and release some resources earlier than with "option httpclose".
Willy Tarreaubf1f8162007-12-28 17:42:56 +01005640
Willy Tarreau8a8e1d92010-04-05 16:15:16 +02005641 This option may also be combined with "option http-pretend-keepalive", which
5642 will disable sending of the "Connection: close" header, but will still cause
5643 the connection to be closed once the whole response is received.
5644
Cyril Bonté653dcd62014-02-20 00:13:15 +01005645 This option disables and replaces any previous "option httpclose", "option
5646 http-server-close", "option http-keep-alive", or "option http-tunnel".
Willy Tarreau02bce8b2014-01-30 00:15:28 +01005647
Willy Tarreaubf1f8162007-12-28 17:42:56 +01005648 If this option has been enabled in a "defaults" section, it can be disabled
5649 in a specific instance by prepending the "no" keyword before it.
5650
Willy Tarreau8a8e1d92010-04-05 16:15:16 +02005651 See also : "option httpclose" and "option http-pretend-keepalive"
Willy Tarreaubf1f8162007-12-28 17:42:56 +01005652
5653
Willy Tarreau87cf5142011-08-19 22:57:24 +02005654option forwardfor [ except <network> ] [ header <name> ] [ if-none ]
Willy Tarreauc27debf2008-01-06 08:57:02 +01005655 Enable insertion of the X-Forwarded-For header to requests sent to servers
5656 May be used in sections : defaults | frontend | listen | backend
5657 yes | yes | yes | yes
5658 Arguments :
5659 <network> is an optional argument used to disable this option for sources
5660 matching <network>
Ross Westaf72a1d2008-08-03 10:51:45 +02005661 <name> an optional argument to specify a different "X-Forwarded-For"
Willy Tarreaud72758d2010-01-12 10:42:19 +01005662 header name.
Willy Tarreauc27debf2008-01-06 08:57:02 +01005663
5664 Since HAProxy works in reverse-proxy mode, the servers see its IP address as
5665 their client address. This is sometimes annoying when the client's IP address
5666 is expected in server logs. To solve this problem, the well-known HTTP header
5667 "X-Forwarded-For" may be added by HAProxy to all requests sent to the server.
5668 This header contains a value representing the client's IP address. Since this
5669 header is always appended at the end of the existing header list, the server
5670 must be configured to always use the last occurrence of this header only. See
Ross Westaf72a1d2008-08-03 10:51:45 +02005671 the server's manual to find how to enable use of this standard header. Note
5672 that only the last occurrence of the header must be used, since it is really
5673 possible that the client has already brought one.
5674
Willy Tarreaud72758d2010-01-12 10:42:19 +01005675 The keyword "header" may be used to supply a different header name to replace
Ross Westaf72a1d2008-08-03 10:51:45 +02005676 the default "X-Forwarded-For". This can be useful where you might already
Davor Ocelice9ed2812017-12-25 17:49:28 +01005677 have a "X-Forwarded-For" header from a different application (e.g. stunnel),
Willy Tarreaud72758d2010-01-12 10:42:19 +01005678 and you need preserve it. Also if your backend server doesn't use the
Davor Ocelice9ed2812017-12-25 17:49:28 +01005679 "X-Forwarded-For" header and requires different one (e.g. Zeus Web Servers
Ross Westaf72a1d2008-08-03 10:51:45 +02005680 require "X-Cluster-Client-IP").
Willy Tarreauc27debf2008-01-06 08:57:02 +01005681
5682 Sometimes, a same HAProxy instance may be shared between a direct client
5683 access and a reverse-proxy access (for instance when an SSL reverse-proxy is
5684 used to decrypt HTTPS traffic). It is possible to disable the addition of the
5685 header for a known source address or network by adding the "except" keyword
5686 followed by the network address. In this case, any source IP matching the
5687 network will not cause an addition of this header. Most common uses are with
5688 private networks or 127.0.0.1.
5689
Willy Tarreau87cf5142011-08-19 22:57:24 +02005690 Alternatively, the keyword "if-none" states that the header will only be
5691 added if it is not present. This should only be used in perfectly trusted
5692 environment, as this might cause a security issue if headers reaching haproxy
5693 are under the control of the end-user.
5694
Willy Tarreauc27debf2008-01-06 08:57:02 +01005695 This option may be specified either in the frontend or in the backend. If at
Ross Westaf72a1d2008-08-03 10:51:45 +02005696 least one of them uses it, the header will be added. Note that the backend's
5697 setting of the header subargument takes precedence over the frontend's if
Willy Tarreau87cf5142011-08-19 22:57:24 +02005698 both are defined. In the case of the "if-none" argument, if at least one of
5699 the frontend or the backend does not specify it, it wants the addition to be
5700 mandatory, so it wins.
Willy Tarreauc27debf2008-01-06 08:57:02 +01005701
Olivier Doucetaa1ea8a2016-08-05 17:15:20 +02005702 Example :
Willy Tarreauc27debf2008-01-06 08:57:02 +01005703 # Public HTTP address also used by stunnel on the same machine
5704 frontend www
5705 mode http
5706 option forwardfor except 127.0.0.1 # stunnel already adds the header
5707
Ross Westaf72a1d2008-08-03 10:51:45 +02005708 # Those servers want the IP Address in X-Client
5709 backend www
5710 mode http
5711 option forwardfor header X-Client
5712
Willy Tarreau87cf5142011-08-19 22:57:24 +02005713 See also : "option httpclose", "option http-server-close",
Willy Tarreau70dffda2014-01-30 03:07:23 +01005714 "option forceclose", "option http-keep-alive"
Willy Tarreauc27debf2008-01-06 08:57:02 +01005715
Willy Tarreau8a8e1d92010-04-05 16:15:16 +02005716
Willy Tarreau9fbe18e2015-05-01 22:42:08 +02005717option http-buffer-request
5718no option http-buffer-request
5719 Enable or disable waiting for whole HTTP request body before proceeding
5720 May be used in sections : defaults | frontend | listen | backend
5721 yes | yes | yes | yes
5722 Arguments : none
5723
5724 It is sometimes desirable to wait for the body of an HTTP request before
5725 taking a decision. This is what is being done by "balance url_param" for
5726 example. The first use case is to buffer requests from slow clients before
5727 connecting to the server. Another use case consists in taking the routing
5728 decision based on the request body's contents. This option placed in a
5729 frontend or backend forces the HTTP processing to wait until either the whole
5730 body is received, or the request buffer is full, or the first chunk is
5731 complete in case of chunked encoding. It can have undesired side effects with
Tim Düsterhus4896c442016-11-29 02:15:19 +01005732 some applications abusing HTTP by expecting unbuffered transmissions between
Willy Tarreau9fbe18e2015-05-01 22:42:08 +02005733 the frontend and the backend, so this should definitely not be used by
5734 default.
5735
Baptiste Assmanneccdf432015-10-28 13:49:01 +01005736 See also : "option http-no-delay", "timeout http-request"
Willy Tarreau9fbe18e2015-05-01 22:42:08 +02005737
5738
Willy Tarreau0f228a02015-05-01 15:37:53 +02005739option http-ignore-probes
5740no option http-ignore-probes
5741 Enable or disable logging of null connections and request timeouts
5742 May be used in sections : defaults | frontend | listen | backend
5743 yes | yes | yes | no
5744 Arguments : none
5745
5746 Recently some browsers started to implement a "pre-connect" feature
5747 consisting in speculatively connecting to some recently visited web sites
5748 just in case the user would like to visit them. This results in many
5749 connections being established to web sites, which end up in 408 Request
5750 Timeout if the timeout strikes first, or 400 Bad Request when the browser
5751 decides to close them first. These ones pollute the log and feed the error
5752 counters. There was already "option dontlognull" but it's insufficient in
5753 this case. Instead, this option does the following things :
5754 - prevent any 400/408 message from being sent to the client if nothing
Davor Ocelice9ed2812017-12-25 17:49:28 +01005755 was received over a connection before it was closed;
5756 - prevent any log from being emitted in this situation;
Willy Tarreau0f228a02015-05-01 15:37:53 +02005757 - prevent any error counter from being incremented
5758
5759 That way the empty connection is silently ignored. Note that it is better
5760 not to use this unless it is clear that it is needed, because it will hide
5761 real problems. The most common reason for not receiving a request and seeing
5762 a 408 is due to an MTU inconsistency between the client and an intermediary
5763 element such as a VPN, which blocks too large packets. These issues are
5764 generally seen with POST requests as well as GET with large cookies. The logs
5765 are often the only way to detect them.
5766
5767 If this option has been enabled in a "defaults" section, it can be disabled
5768 in a specific instance by prepending the "no" keyword before it.
5769
5770 See also : "log", "dontlognull", "errorfile", and section 8 about logging.
5771
5772
Willy Tarreau16bfb022010-01-16 19:48:41 +01005773option http-keep-alive
5774no option http-keep-alive
5775 Enable or disable HTTP keep-alive from client to server
5776 May be used in sections : defaults | frontend | listen | backend
5777 yes | yes | yes | yes
5778 Arguments : none
5779
Willy Tarreau70dffda2014-01-30 03:07:23 +01005780 By default HAProxy operates in keep-alive mode with regards to persistent
5781 connections: for each connection it processes each request and response, and
5782 leaves the connection idle on both sides between the end of a response and the
5783 start of a new request. This mode may be changed by several options such as
5784 "option http-server-close", "option forceclose", "option httpclose" or
5785 "option http-tunnel". This option allows to set back the keep-alive mode,
5786 which can be useful when another mode was used in a defaults section.
5787
5788 Setting "option http-keep-alive" enables HTTP keep-alive mode on the client-
5789 and server- sides. This provides the lowest latency on the client side (slow
Willy Tarreau16bfb022010-01-16 19:48:41 +01005790 network) and the fastest session reuse on the server side at the expense
5791 of maintaining idle connections to the servers. In general, it is possible
5792 with this option to achieve approximately twice the request rate that the
5793 "http-server-close" option achieves on small objects. There are mainly two
5794 situations where this option may be useful :
5795
5796 - when the server is non-HTTP compliant and authenticates the connection
Davor Ocelice9ed2812017-12-25 17:49:28 +01005797 instead of requests (e.g. NTLM authentication)
Willy Tarreau16bfb022010-01-16 19:48:41 +01005798
5799 - when the cost of establishing the connection to the server is significant
5800 compared to the cost of retrieving the associated object from the server.
5801
5802 This last case can happen when the server is a fast static server of cache.
5803 In this case, the server will need to be properly tuned to support high enough
5804 connection counts because connections will last until the client sends another
5805 request.
5806
5807 If the client request has to go to another backend or another server due to
5808 content switching or the load balancing algorithm, the idle connection will
Willy Tarreau9420b122013-12-15 18:58:25 +01005809 immediately be closed and a new one re-opened. Option "prefer-last-server" is
5810 available to try optimize server selection so that if the server currently
5811 attached to an idle connection is usable, it will be used.
Willy Tarreau16bfb022010-01-16 19:48:41 +01005812
Willy Tarreau16bfb022010-01-16 19:48:41 +01005813 At the moment, logs will not indicate whether requests came from the same
5814 session or not. The accept date reported in the logs corresponds to the end
5815 of the previous request, and the request time corresponds to the time spent
5816 waiting for a new request. The keep-alive request time is still bound to the
5817 timeout defined by "timeout http-keep-alive" or "timeout http-request" if
5818 not set.
5819
Cyril Bonté653dcd62014-02-20 00:13:15 +01005820 This option disables and replaces any previous "option httpclose", "option
5821 http-server-close", "option forceclose" or "option http-tunnel". When backend
Willy Tarreau70dffda2014-01-30 03:07:23 +01005822 and frontend options differ, all of these 4 options have precedence over
Cyril Bonté653dcd62014-02-20 00:13:15 +01005823 "option http-keep-alive".
Willy Tarreau16bfb022010-01-16 19:48:41 +01005824
5825 See also : "option forceclose", "option http-server-close",
Willy Tarreau9420b122013-12-15 18:58:25 +01005826 "option prefer-last-server", "option http-pretend-keepalive",
5827 "option httpclose", and "1.1. The HTTP transaction model".
Willy Tarreau16bfb022010-01-16 19:48:41 +01005828
5829
Willy Tarreau96e31212011-05-30 18:10:30 +02005830option http-no-delay
5831no option http-no-delay
5832 Instruct the system to favor low interactive delays over performance in HTTP
5833 May be used in sections : defaults | frontend | listen | backend
5834 yes | yes | yes | yes
5835 Arguments : none
5836
5837 In HTTP, each payload is unidirectional and has no notion of interactivity.
5838 Any agent is expected to queue data somewhat for a reasonably low delay.
5839 There are some very rare server-to-server applications that abuse the HTTP
5840 protocol and expect the payload phase to be highly interactive, with many
5841 interleaved data chunks in both directions within a single request. This is
5842 absolutely not supported by the HTTP specification and will not work across
5843 most proxies or servers. When such applications attempt to do this through
5844 haproxy, it works but they will experience high delays due to the network
5845 optimizations which favor performance by instructing the system to wait for
5846 enough data to be available in order to only send full packets. Typical
5847 delays are around 200 ms per round trip. Note that this only happens with
5848 abnormal uses. Normal uses such as CONNECT requests nor WebSockets are not
5849 affected.
5850
5851 When "option http-no-delay" is present in either the frontend or the backend
5852 used by a connection, all such optimizations will be disabled in order to
5853 make the exchanges as fast as possible. Of course this offers no guarantee on
5854 the functionality, as it may break at any other place. But if it works via
5855 HAProxy, it will work as fast as possible. This option should never be used
5856 by default, and should never be used at all unless such a buggy application
5857 is discovered. The impact of using this option is an increase of bandwidth
5858 usage and CPU usage, which may significantly lower performance in high
5859 latency environments.
5860
Willy Tarreau9fbe18e2015-05-01 22:42:08 +02005861 See also : "option http-buffer-request"
5862
Willy Tarreau96e31212011-05-30 18:10:30 +02005863
Willy Tarreau8a8e1d92010-04-05 16:15:16 +02005864option http-pretend-keepalive
5865no option http-pretend-keepalive
5866 Define whether haproxy will announce keepalive to the server or not
5867 May be used in sections : defaults | frontend | listen | backend
5868 yes | yes | yes | yes
5869 Arguments : none
5870
5871 When running with "option http-server-close" or "option forceclose", haproxy
5872 adds a "Connection: close" header to the request forwarded to the server.
5873 Unfortunately, when some servers see this header, they automatically refrain
5874 from using the chunked encoding for responses of unknown length, while this
5875 is totally unrelated. The immediate effect is that this prevents haproxy from
5876 maintaining the client connection alive. A second effect is that a client or
5877 a cache could receive an incomplete response without being aware of it, and
5878 consider the response complete.
5879
5880 By setting "option http-pretend-keepalive", haproxy will make the server
5881 believe it will keep the connection alive. The server will then not fall back
5882 to the abnormal undesired above. When haproxy gets the whole response, it
5883 will close the connection with the server just as it would do with the
5884 "forceclose" option. That way the client gets a normal response and the
5885 connection is correctly closed on the server side.
5886
5887 It is recommended not to enable this option by default, because most servers
5888 will more efficiently close the connection themselves after the last packet,
5889 and release its buffers slightly earlier. Also, the added packet on the
5890 network could slightly reduce the overall peak performance. However it is
5891 worth noting that when this option is enabled, haproxy will have slightly
5892 less work to do. So if haproxy is the bottleneck on the whole architecture,
5893 enabling this option might save a few CPU cycles.
5894
5895 This option may be set both in a frontend and in a backend. It is enabled if
5896 at least one of the frontend or backend holding a connection has it enabled.
Jamie Gloudonaaa21002012-08-25 00:18:33 -04005897 This option may be combined with "option httpclose", which will cause
Willy Tarreau22a95342010-09-29 14:31:41 +02005898 keepalive to be announced to the server and close to be announced to the
5899 client. This practice is discouraged though.
Willy Tarreau8a8e1d92010-04-05 16:15:16 +02005900
5901 If this option has been enabled in a "defaults" section, it can be disabled
5902 in a specific instance by prepending the "no" keyword before it.
5903
Willy Tarreau16bfb022010-01-16 19:48:41 +01005904 See also : "option forceclose", "option http-server-close", and
5905 "option http-keep-alive"
Willy Tarreau8a8e1d92010-04-05 16:15:16 +02005906
Willy Tarreauc27debf2008-01-06 08:57:02 +01005907
Willy Tarreaub608feb2010-01-02 22:47:18 +01005908option http-server-close
5909no option http-server-close
5910 Enable or disable HTTP connection closing on the server side
5911 May be used in sections : defaults | frontend | listen | backend
5912 yes | yes | yes | yes
5913 Arguments : none
5914
Willy Tarreau70dffda2014-01-30 03:07:23 +01005915 By default HAProxy operates in keep-alive mode with regards to persistent
5916 connections: for each connection it processes each request and response, and
5917 leaves the connection idle on both sides between the end of a response and
5918 the start of a new request. This mode may be changed by several options such
5919 as "option http-server-close", "option forceclose", "option httpclose" or
5920 "option http-tunnel". Setting "option http-server-close" enables HTTP
5921 connection-close mode on the server side while keeping the ability to support
Davor Ocelice9ed2812017-12-25 17:49:28 +01005922 HTTP keep-alive and pipelining on the client side. This provides the lowest
Willy Tarreau70dffda2014-01-30 03:07:23 +01005923 latency on the client side (slow network) and the fastest session reuse on
5924 the server side to save server resources, similarly to "option forceclose".
5925 It also permits non-keepalive capable servers to be served in keep-alive mode
Lukas Tribus23953682017-04-28 13:24:30 +00005926 to the clients if they conform to the requirements of RFC7230. Please note
Willy Tarreau70dffda2014-01-30 03:07:23 +01005927 that some servers do not always conform to those requirements when they see
5928 "Connection: close" in the request. The effect will be that keep-alive will
5929 never be used. A workaround consists in enabling "option
5930 http-pretend-keepalive".
Willy Tarreaub608feb2010-01-02 22:47:18 +01005931
5932 At the moment, logs will not indicate whether requests came from the same
5933 session or not. The accept date reported in the logs corresponds to the end
5934 of the previous request, and the request time corresponds to the time spent
5935 waiting for a new request. The keep-alive request time is still bound to the
Willy Tarreaub16a5742010-01-10 14:46:16 +01005936 timeout defined by "timeout http-keep-alive" or "timeout http-request" if
5937 not set.
Willy Tarreaub608feb2010-01-02 22:47:18 +01005938
5939 This option may be set both in a frontend and in a backend. It is enabled if
5940 at least one of the frontend or backend holding a connection has it enabled.
Cyril Bonté653dcd62014-02-20 00:13:15 +01005941 It disables and replaces any previous "option httpclose", "option forceclose",
5942 "option http-tunnel" or "option http-keep-alive". Please check section 4
Willy Tarreau70dffda2014-01-30 03:07:23 +01005943 ("Proxies") to see how this option combines with others when frontend and
5944 backend options differ.
Willy Tarreaub608feb2010-01-02 22:47:18 +01005945
5946 If this option has been enabled in a "defaults" section, it can be disabled
5947 in a specific instance by prepending the "no" keyword before it.
5948
Patrick Mezard9ec2ec42010-06-12 17:02:45 +02005949 See also : "option forceclose", "option http-pretend-keepalive",
Willy Tarreau16bfb022010-01-16 19:48:41 +01005950 "option httpclose", "option http-keep-alive", and
5951 "1.1. The HTTP transaction model".
Willy Tarreaub608feb2010-01-02 22:47:18 +01005952
5953
Willy Tarreau02bce8b2014-01-30 00:15:28 +01005954option http-tunnel
5955no option http-tunnel
5956 Disable or enable HTTP connection processing after first transaction
5957 May be used in sections : defaults | frontend | listen | backend
5958 yes | yes | yes | yes
5959 Arguments : none
5960
Willy Tarreau70dffda2014-01-30 03:07:23 +01005961 By default HAProxy operates in keep-alive mode with regards to persistent
5962 connections: for each connection it processes each request and response, and
5963 leaves the connection idle on both sides between the end of a response and
5964 the start of a new request. This mode may be changed by several options such
5965 as "option http-server-close", "option forceclose", "option httpclose" or
5966 "option http-tunnel".
5967
5968 Option "http-tunnel" disables any HTTP processing past the first request and
Jarno Huuskonen0e82b922014-04-12 18:22:19 +03005969 the first response. This is the mode which was used by default in versions
Willy Tarreau70dffda2014-01-30 03:07:23 +01005970 1.0 to 1.5-dev21. It is the mode with the lowest processing overhead, which
5971 is normally not needed anymore unless in very specific cases such as when
5972 using an in-house protocol that looks like HTTP but is not compatible, or
5973 just to log one request per client in order to reduce log size. Note that
5974 everything which works at the HTTP level, including header parsing/addition,
5975 cookie processing or content switching will only work for the first request
5976 and will be ignored after the first response.
Willy Tarreau02bce8b2014-01-30 00:15:28 +01005977
5978 If this option has been enabled in a "defaults" section, it can be disabled
5979 in a specific instance by prepending the "no" keyword before it.
5980
5981 See also : "option forceclose", "option http-server-close",
5982 "option httpclose", "option http-keep-alive", and
5983 "1.1. The HTTP transaction model".
5984
5985
Willy Tarreau88d349d2010-01-25 12:15:43 +01005986option http-use-proxy-header
Cyril Bontéf0c60612010-02-06 14:44:47 +01005987no option http-use-proxy-header
Willy Tarreau88d349d2010-01-25 12:15:43 +01005988 Make use of non-standard Proxy-Connection header instead of Connection
5989 May be used in sections : defaults | frontend | listen | backend
5990 yes | yes | yes | no
5991 Arguments : none
5992
Lukas Tribus23953682017-04-28 13:24:30 +00005993 While RFC7230 explicitly states that HTTP/1.1 agents must use the
Willy Tarreau88d349d2010-01-25 12:15:43 +01005994 Connection header to indicate their wish of persistent or non-persistent
5995 connections, both browsers and proxies ignore this header for proxied
5996 connections and make use of the undocumented, non-standard Proxy-Connection
5997 header instead. The issue begins when trying to put a load balancer between
5998 browsers and such proxies, because there will be a difference between what
5999 haproxy understands and what the client and the proxy agree on.
6000
6001 By setting this option in a frontend, haproxy can automatically switch to use
6002 that non-standard header if it sees proxied requests. A proxied request is
Lukas Tribusf01a9cd2016-02-03 18:09:37 +01006003 defined here as one where the URI begins with neither a '/' nor a '*'. This
6004 is incompatible with the HTTP tunnel mode. Note that this option can only be
6005 specified in a frontend and will affect the request along its whole life.
Willy Tarreau88d349d2010-01-25 12:15:43 +01006006
Willy Tarreau844a7e72010-01-31 21:46:18 +01006007 Also, when this option is set, a request which requires authentication will
6008 automatically switch to use proxy authentication headers if it is itself a
6009 proxied request. That makes it possible to check or enforce authentication in
6010 front of an existing proxy.
6011
Willy Tarreau88d349d2010-01-25 12:15:43 +01006012 This option should normally never be used, except in front of a proxy.
6013
6014 See also : "option httpclose", "option forceclose" and "option
6015 http-server-close".
6016
6017
Willy Tarreaud63335a2010-02-26 12:56:52 +01006018option httpchk
6019option httpchk <uri>
6020option httpchk <method> <uri>
6021option httpchk <method> <uri> <version>
6022 Enable HTTP protocol to check on the servers health
6023 May be used in sections : defaults | frontend | listen | backend
6024 yes | no | yes | yes
6025 Arguments :
6026 <method> is the optional HTTP method used with the requests. When not set,
6027 the "OPTIONS" method is used, as it generally requires low server
6028 processing and is easy to filter out from the logs. Any method
6029 may be used, though it is not recommended to invent non-standard
6030 ones.
6031
6032 <uri> is the URI referenced in the HTTP requests. It defaults to " / "
6033 which is accessible by default on almost any server, but may be
6034 changed to any other URI. Query strings are permitted.
6035
6036 <version> is the optional HTTP version string. It defaults to "HTTP/1.0"
6037 but some servers might behave incorrectly in HTTP 1.0, so turning
6038 it to HTTP/1.1 may sometimes help. Note that the Host field is
6039 mandatory in HTTP/1.1, and as a trick, it is possible to pass it
6040 after "\r\n" following the version string.
6041
6042 By default, server health checks only consist in trying to establish a TCP
6043 connection. When "option httpchk" is specified, a complete HTTP request is
6044 sent once the TCP connection is established, and responses 2xx and 3xx are
6045 considered valid, while all other ones indicate a server failure, including
6046 the lack of any response.
6047
6048 The port and interval are specified in the server configuration.
6049
6050 This option does not necessarily require an HTTP backend, it also works with
6051 plain TCP backends. This is particularly useful to check simple scripts bound
6052 to some dedicated ports using the inetd daemon.
6053
6054 Examples :
6055 # Relay HTTPS traffic to Apache instance and check service availability
6056 # using HTTP request "OPTIONS * HTTP/1.1" on port 80.
6057 backend https_relay
6058 mode tcp
6059 option httpchk OPTIONS * HTTP/1.1\r\nHost:\ www
6060 server apache1 192.168.1.1:443 check port 80
6061
Simon Hormanafc47ee2013-11-25 10:46:35 +09006062 See also : "option ssl-hello-chk", "option smtpchk", "option mysql-check",
6063 "option pgsql-check", "http-check" and the "check", "port" and
6064 "inter" server options.
Willy Tarreaud63335a2010-02-26 12:56:52 +01006065
6066
Willy Tarreauc27debf2008-01-06 08:57:02 +01006067option httpclose
6068no option httpclose
6069 Enable or disable passive HTTP connection closing
6070 May be used in sections : defaults | frontend | listen | backend
6071 yes | yes | yes | yes
6072 Arguments : none
6073
Willy Tarreau70dffda2014-01-30 03:07:23 +01006074 By default HAProxy operates in keep-alive mode with regards to persistent
6075 connections: for each connection it processes each request and response, and
6076 leaves the connection idle on both sides between the end of a response and
6077 the start of a new request. This mode may be changed by several options such
Cyril Bonté653dcd62014-02-20 00:13:15 +01006078 as "option http-server-close", "option forceclose", "option httpclose" or
Willy Tarreau70dffda2014-01-30 03:07:23 +01006079 "option http-tunnel".
6080
6081 If "option httpclose" is set, HAProxy will work in HTTP tunnel mode and check
6082 if a "Connection: close" header is already set in each direction, and will
6083 add one if missing. Each end should react to this by actively closing the TCP
6084 connection after each transfer, thus resulting in a switch to the HTTP close
6085 mode. Any "Connection" header different from "close" will also be removed.
6086 Note that this option is deprecated since what it does is very cheap but not
6087 reliable. Using "option http-server-close" or "option forceclose" is strongly
6088 recommended instead.
Willy Tarreauc27debf2008-01-06 08:57:02 +01006089
6090 It seldom happens that some servers incorrectly ignore this header and do not
Jamie Gloudonaaa21002012-08-25 00:18:33 -04006091 close the connection even though they reply "Connection: close". For this
Willy Tarreau0dfdf192010-01-05 11:33:11 +01006092 reason, they are not compatible with older HTTP 1.0 browsers. If this happens
6093 it is possible to use the "option forceclose" which actively closes the
6094 request connection once the server responds. Option "forceclose" also
6095 releases the server connection earlier because it does not have to wait for
6096 the client to acknowledge it.
Willy Tarreauc27debf2008-01-06 08:57:02 +01006097
6098 This option may be set both in a frontend and in a backend. It is enabled if
6099 at least one of the frontend or backend holding a connection has it enabled.
Cyril Bonté653dcd62014-02-20 00:13:15 +01006100 It disables and replaces any previous "option http-server-close",
6101 "option forceclose", "option http-keep-alive" or "option http-tunnel". Please
Willy Tarreau70dffda2014-01-30 03:07:23 +01006102 check section 4 ("Proxies") to see how this option combines with others when
6103 frontend and backend options differ.
Willy Tarreauc27debf2008-01-06 08:57:02 +01006104
6105 If this option has been enabled in a "defaults" section, it can be disabled
6106 in a specific instance by prepending the "no" keyword before it.
6107
Patrick Mezard9ec2ec42010-06-12 17:02:45 +02006108 See also : "option forceclose", "option http-server-close" and
6109 "1.1. The HTTP transaction model".
Willy Tarreauc27debf2008-01-06 08:57:02 +01006110
6111
Emeric Brun3a058f32009-06-30 18:26:00 +02006112option httplog [ clf ]
Willy Tarreauc27debf2008-01-06 08:57:02 +01006113 Enable logging of HTTP request, session state and timers
6114 May be used in sections : defaults | frontend | listen | backend
Tim Duesterhus9ad9f352018-02-05 20:52:27 +01006115 yes | yes | yes | no
Emeric Brun3a058f32009-06-30 18:26:00 +02006116 Arguments :
6117 clf if the "clf" argument is added, then the output format will be
6118 the CLF format instead of HAProxy's default HTTP format. You can
6119 use this when you need to feed HAProxy's logs through a specific
Davor Ocelice9ed2812017-12-25 17:49:28 +01006120 log analyzer which only support the CLF format and which is not
Emeric Brun3a058f32009-06-30 18:26:00 +02006121 extensible.
Willy Tarreauc27debf2008-01-06 08:57:02 +01006122
6123 By default, the log output format is very poor, as it only contains the
6124 source and destination addresses, and the instance name. By specifying
6125 "option httplog", each log line turns into a much richer format including,
6126 but not limited to, the HTTP request, the connection timers, the session
6127 status, the connections numbers, the captured headers and cookies, the
6128 frontend, backend and server name, and of course the source address and
6129 ports.
6130
PiBa-NLbd556bf2014-12-11 21:31:54 +01006131 Specifying only "option httplog" will automatically clear the 'clf' mode
6132 if it was set by default.
Emeric Brun3a058f32009-06-30 18:26:00 +02006133
Guillaume de Lafond29f45602017-03-31 19:52:15 +02006134 "option httplog" overrides any previous "log-format" directive.
6135
Willy Tarreauc57f0e22009-05-10 13:12:33 +02006136 See also : section 8 about logging.
Willy Tarreauc27debf2008-01-06 08:57:02 +01006137
Willy Tarreau55165fe2009-05-10 12:02:55 +02006138
6139option http_proxy
6140no option http_proxy
6141 Enable or disable plain HTTP proxy mode
6142 May be used in sections : defaults | frontend | listen | backend
6143 yes | yes | yes | yes
6144 Arguments : none
6145
6146 It sometimes happens that people need a pure HTTP proxy which understands
6147 basic proxy requests without caching nor any fancy feature. In this case,
6148 it may be worth setting up an HAProxy instance with the "option http_proxy"
6149 set. In this mode, no server is declared, and the connection is forwarded to
6150 the IP address and port found in the URL after the "http://" scheme.
6151
6152 No host address resolution is performed, so this only works when pure IP
6153 addresses are passed. Since this option's usage perimeter is rather limited,
Lukas Tribusf01a9cd2016-02-03 18:09:37 +01006154 it will probably be used only by experts who know they need exactly it. This
6155 is incompatible with the HTTP tunnel mode.
Willy Tarreau55165fe2009-05-10 12:02:55 +02006156
6157 If this option has been enabled in a "defaults" section, it can be disabled
6158 in a specific instance by prepending the "no" keyword before it.
6159
6160 Example :
6161 # this backend understands HTTP proxy requests and forwards them directly.
6162 backend direct_forward
6163 option httpclose
6164 option http_proxy
6165
6166 See also : "option httpclose"
6167
Willy Tarreau211ad242009-10-03 21:45:07 +02006168
Jamie Gloudon801a0a32012-08-25 00:18:33 -04006169option independent-streams
6170no option independent-streams
6171 Enable or disable independent timeout processing for both directions
Willy Tarreauf27b5ea2009-10-03 22:01:18 +02006172 May be used in sections : defaults | frontend | listen | backend
6173 yes | yes | yes | yes
6174 Arguments : none
6175
6176 By default, when data is sent over a socket, both the write timeout and the
6177 read timeout for that socket are refreshed, because we consider that there is
6178 activity on that socket, and we have no other means of guessing if we should
6179 receive data or not.
6180
Davor Ocelice9ed2812017-12-25 17:49:28 +01006181 While this default behavior is desirable for almost all applications, there
Willy Tarreauf27b5ea2009-10-03 22:01:18 +02006182 exists a situation where it is desirable to disable it, and only refresh the
6183 read timeout if there are incoming data. This happens on sessions with large
6184 timeouts and low amounts of exchanged data such as telnet session. If the
6185 server suddenly disappears, the output data accumulates in the system's
6186 socket buffers, both timeouts are correctly refreshed, and there is no way
6187 to know the server does not receive them, so we don't timeout. However, when
6188 the underlying protocol always echoes sent data, it would be enough by itself
6189 to detect the issue using the read timeout. Note that this problem does not
6190 happen with more verbose protocols because data won't accumulate long in the
6191 socket buffers.
6192
6193 When this option is set on the frontend, it will disable read timeout updates
6194 on data sent to the client. There probably is little use of this case. When
6195 the option is set on the backend, it will disable read timeout updates on
6196 data sent to the server. Doing so will typically break large HTTP posts from
6197 slow lines, so use it with caution.
6198
Jarno Huuskonen0e82b922014-04-12 18:22:19 +03006199 Note: older versions used to call this setting "option independent-streams"
Jamie Gloudon801a0a32012-08-25 00:18:33 -04006200 with a spelling mistake. This spelling is still supported but
6201 deprecated.
6202
Willy Tarreauce887fd2012-05-12 12:50:00 +02006203 See also : "timeout client", "timeout server" and "timeout tunnel"
Willy Tarreauf27b5ea2009-10-03 22:01:18 +02006204
6205
Gabor Lekenyb4c81e42010-09-29 18:17:05 +02006206option ldap-check
6207 Use LDAPv3 health checks for server testing
6208 May be used in sections : defaults | frontend | listen | backend
6209 yes | no | yes | yes
6210 Arguments : none
6211
6212 It is possible to test that the server correctly talks LDAPv3 instead of just
6213 testing that it accepts the TCP connection. When this option is set, an
6214 LDAPv3 anonymous simple bind message is sent to the server, and the response
6215 is analyzed to find an LDAPv3 bind response message.
6216
6217 The server is considered valid only when the LDAP response contains success
6218 resultCode (http://tools.ietf.org/html/rfc4511#section-4.1.9).
6219
6220 Logging of bind requests is server dependent see your documentation how to
6221 configure it.
6222
6223 Example :
6224 option ldap-check
6225
6226 See also : "option httpchk"
6227
6228
Simon Horman98637e52014-06-20 12:30:16 +09006229option external-check
6230 Use external processes for server health checks
6231 May be used in sections : defaults | frontend | listen | backend
6232 yes | no | yes | yes
6233
6234 It is possible to test the health of a server using an external command.
6235 This is achieved by running the executable set using "external-check
6236 command".
6237
6238 Requires the "external-check" global to be set.
6239
6240 See also : "external-check", "external-check command", "external-check path"
6241
6242
Willy Tarreau211ad242009-10-03 21:45:07 +02006243option log-health-checks
6244no option log-health-checks
Willy Tarreaubef1b322014-05-13 21:01:39 +02006245 Enable or disable logging of health checks status updates
Willy Tarreau211ad242009-10-03 21:45:07 +02006246 May be used in sections : defaults | frontend | listen | backend
6247 yes | no | yes | yes
6248 Arguments : none
6249
Willy Tarreaubef1b322014-05-13 21:01:39 +02006250 By default, failed health check are logged if server is UP and successful
6251 health checks are logged if server is DOWN, so the amount of additional
6252 information is limited.
Willy Tarreau211ad242009-10-03 21:45:07 +02006253
Willy Tarreaubef1b322014-05-13 21:01:39 +02006254 When this option is enabled, any change of the health check status or to
6255 the server's health will be logged, so that it becomes possible to know
6256 that a server was failing occasional checks before crashing, or exactly when
6257 it failed to respond a valid HTTP status, then when the port started to
6258 reject connections, then when the server stopped responding at all.
6259
Davor Ocelice9ed2812017-12-25 17:49:28 +01006260 Note that status changes not caused by health checks (e.g. enable/disable on
Willy Tarreaubef1b322014-05-13 21:01:39 +02006261 the CLI) are intentionally not logged by this option.
Willy Tarreau211ad242009-10-03 21:45:07 +02006262
Willy Tarreaubef1b322014-05-13 21:01:39 +02006263 See also: "option httpchk", "option ldap-check", "option mysql-check",
6264 "option pgsql-check", "option redis-check", "option smtpchk",
6265 "option tcp-check", "log" and section 8 about logging.
Willy Tarreau211ad242009-10-03 21:45:07 +02006266
Willy Tarreauc9bd0cc2009-05-10 11:57:02 +02006267
6268option log-separate-errors
6269no option log-separate-errors
6270 Change log level for non-completely successful connections
6271 May be used in sections : defaults | frontend | listen | backend
6272 yes | yes | yes | no
6273 Arguments : none
6274
6275 Sometimes looking for errors in logs is not easy. This option makes haproxy
6276 raise the level of logs containing potentially interesting information such
6277 as errors, timeouts, retries, redispatches, or HTTP status codes 5xx. The
6278 level changes from "info" to "err". This makes it possible to log them
6279 separately to a different file with most syslog daemons. Be careful not to
6280 remove them from the original file, otherwise you would lose ordering which
6281 provides very important information.
6282
6283 Using this option, large sites dealing with several thousand connections per
6284 second may log normal traffic to a rotating buffer and only archive smaller
6285 error logs.
6286
Willy Tarreauc57f0e22009-05-10 13:12:33 +02006287 See also : "log", "dontlognull", "dontlog-normal" and section 8 about
Willy Tarreauc9bd0cc2009-05-10 11:57:02 +02006288 logging.
6289
Willy Tarreauc27debf2008-01-06 08:57:02 +01006290
6291option logasap
6292no option logasap
6293 Enable or disable early logging of HTTP requests
6294 May be used in sections : defaults | frontend | listen | backend
6295 yes | yes | yes | no
6296 Arguments : none
6297
6298 By default, HTTP requests are logged upon termination so that the total
6299 transfer time and the number of bytes appear in the logs. When large objects
6300 are being transferred, it may take a while before the request appears in the
6301 logs. Using "option logasap", the request gets logged as soon as the server
6302 sends the complete headers. The only missing information in the logs will be
6303 the total number of bytes which will indicate everything except the amount
6304 of data transferred, and the total time which will not take the transfer
Willy Tarreaud2a4aa22008-01-31 15:28:22 +01006305 time into account. In such a situation, it's a good practice to capture the
Willy Tarreauc27debf2008-01-06 08:57:02 +01006306 "Content-Length" response header so that the logs at least indicate how many
6307 bytes are expected to be transferred.
6308
Willy Tarreaucc6c8912009-02-22 10:53:55 +01006309 Examples :
6310 listen http_proxy 0.0.0.0:80
6311 mode http
6312 option httplog
6313 option logasap
6314 log 192.168.2.200 local3
6315
6316 >>> Feb 6 12:14:14 localhost \
6317 haproxy[14389]: 10.0.1.2:33317 [06/Feb/2009:12:14:14.655] http-in \
6318 static/srv1 9/10/7/14/+30 200 +243 - - ---- 3/1/1/1/0 1/0 \
6319 "GET /image.iso HTTP/1.0"
6320
Willy Tarreauc57f0e22009-05-10 13:12:33 +02006321 See also : "option httplog", "capture response header", and section 8 about
Willy Tarreauc27debf2008-01-06 08:57:02 +01006322 logging.
6323
6324
Nenad Merdanovic6639a7c2014-05-30 14:26:32 +02006325option mysql-check [ user <username> [ post-41 ] ]
Hervé COMMOWICK8776f1b2010-10-18 15:58:36 +02006326 Use MySQL health checks for server testing
Hervé COMMOWICK698ae002010-01-12 09:25:13 +01006327 May be used in sections : defaults | frontend | listen | backend
6328 yes | no | yes | yes
Hervé COMMOWICK8776f1b2010-10-18 15:58:36 +02006329 Arguments :
Cyril Bonté108cf6e2012-04-21 23:30:29 +02006330 <username> This is the username which will be used when connecting to MySQL
6331 server.
Nenad Merdanovic6639a7c2014-05-30 14:26:32 +02006332 post-41 Send post v4.1 client compatible checks
Hervé COMMOWICK8776f1b2010-10-18 15:58:36 +02006333
6334 If you specify a username, the check consists of sending two MySQL packet,
6335 one Client Authentication packet, and one QUIT packet, to correctly close
Davor Ocelice9ed2812017-12-25 17:49:28 +01006336 MySQL session. We then parse the MySQL Handshake Initialization packet and/or
Hervé COMMOWICK8776f1b2010-10-18 15:58:36 +02006337 Error packet. It is a basic but useful test which does not produce error nor
6338 aborted connect on the server. However, it requires adding an authorization
6339 in the MySQL table, like this :
6340
6341 USE mysql;
6342 INSERT INTO user (Host,User) values ('<ip_of_haproxy>','<username>');
6343 FLUSH PRIVILEGES;
6344
6345 If you don't specify a username (it is deprecated and not recommended), the
Davor Ocelice9ed2812017-12-25 17:49:28 +01006346 check only consists in parsing the Mysql Handshake Initialization packet or
Hervé COMMOWICK8776f1b2010-10-18 15:58:36 +02006347 Error packet, we don't send anything in this mode. It was reported that it
6348 can generate lockout if check is too frequent and/or if there is not enough
6349 traffic. In fact, you need in this case to check MySQL "max_connect_errors"
6350 value as if a connection is established successfully within fewer than MySQL
6351 "max_connect_errors" attempts after a previous connection was interrupted,
6352 the error count for the host is cleared to zero. If HAProxy's server get
6353 blocked, the "FLUSH HOSTS" statement is the only way to unblock it.
6354
6355 Remember that this does not check database presence nor database consistency.
6356 To do this, you can use an external check with xinetd for example.
Hervé COMMOWICK698ae002010-01-12 09:25:13 +01006357
Hervé COMMOWICK212f7782011-06-10 14:05:59 +02006358 The check requires MySQL >=3.22, for older version, please use TCP check.
Hervé COMMOWICK698ae002010-01-12 09:25:13 +01006359
6360 Most often, an incoming MySQL server needs to see the client's IP address for
6361 various purposes, including IP privilege matching and connection logging.
6362 When possible, it is often wise to masquerade the client's IP address when
6363 connecting to the server using the "usesrc" argument of the "source" keyword,
Willy Tarreau29fbe512015-08-20 19:35:14 +02006364 which requires the transparent proxy feature to be compiled in, and the MySQL
6365 server to route the client via the machine hosting haproxy.
Hervé COMMOWICK698ae002010-01-12 09:25:13 +01006366
6367 See also: "option httpchk"
6368
6369
Willy Tarreaua453bdd2008-01-08 19:50:52 +01006370option nolinger
6371no option nolinger
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +01006372 Enable or disable immediate session resource cleaning after close
Willy Tarreaua453bdd2008-01-08 19:50:52 +01006373 May be used in sections: defaults | frontend | listen | backend
6374 yes | yes | yes | yes
Willy Tarreaueabeafa2008-01-16 16:17:06 +01006375 Arguments : none
Willy Tarreaua453bdd2008-01-08 19:50:52 +01006376
Davor Ocelice9ed2812017-12-25 17:49:28 +01006377 When clients or servers abort connections in a dirty way (e.g. they are
Willy Tarreaua453bdd2008-01-08 19:50:52 +01006378 physically disconnected), the session timeouts triggers and the session is
6379 closed. But it will remain in FIN_WAIT1 state for some time in the system,
6380 using some resources and possibly limiting the ability to establish newer
6381 connections.
6382
6383 When this happens, it is possible to activate "option nolinger" which forces
6384 the system to immediately remove any socket's pending data on close. Thus,
6385 the session is instantly purged from the system's tables. This usually has
6386 side effects such as increased number of TCP resets due to old retransmits
6387 getting immediately rejected. Some firewalls may sometimes complain about
6388 this too.
6389
6390 For this reason, it is not recommended to use this option when not absolutely
6391 needed. You know that you need it when you have thousands of FIN_WAIT1
6392 sessions on your system (TIME_WAIT ones do not count).
6393
6394 This option may be used both on frontends and backends, depending on the side
6395 where it is required. Use it on the frontend for clients, and on the backend
6396 for servers.
6397
6398 If this option has been enabled in a "defaults" section, it can be disabled
6399 in a specific instance by prepending the "no" keyword before it.
6400
6401
Willy Tarreau55165fe2009-05-10 12:02:55 +02006402option originalto [ except <network> ] [ header <name> ]
6403 Enable insertion of the X-Original-To header to requests sent to servers
6404 May be used in sections : defaults | frontend | listen | backend
6405 yes | yes | yes | yes
6406 Arguments :
6407 <network> is an optional argument used to disable this option for sources
6408 matching <network>
6409 <name> an optional argument to specify a different "X-Original-To"
6410 header name.
6411
6412 Since HAProxy can work in transparent mode, every request from a client can
6413 be redirected to the proxy and HAProxy itself can proxy every request to a
6414 complex SQUID environment and the destination host from SO_ORIGINAL_DST will
6415 be lost. This is annoying when you want access rules based on destination ip
6416 addresses. To solve this problem, a new HTTP header "X-Original-To" may be
6417 added by HAProxy to all requests sent to the server. This header contains a
6418 value representing the original destination IP address. Since this must be
6419 configured to always use the last occurrence of this header only. Note that
6420 only the last occurrence of the header must be used, since it is really
6421 possible that the client has already brought one.
6422
6423 The keyword "header" may be used to supply a different header name to replace
6424 the default "X-Original-To". This can be useful where you might already
6425 have a "X-Original-To" header from a different application, and you need
6426 preserve it. Also if your backend server doesn't use the "X-Original-To"
6427 header and requires different one.
6428
6429 Sometimes, a same HAProxy instance may be shared between a direct client
6430 access and a reverse-proxy access (for instance when an SSL reverse-proxy is
6431 used to decrypt HTTPS traffic). It is possible to disable the addition of the
6432 header for a known source address or network by adding the "except" keyword
6433 followed by the network address. In this case, any source IP matching the
6434 network will not cause an addition of this header. Most common uses are with
6435 private networks or 127.0.0.1.
6436
6437 This option may be specified either in the frontend or in the backend. If at
6438 least one of them uses it, the header will be added. Note that the backend's
6439 setting of the header subargument takes precedence over the frontend's if
6440 both are defined.
6441
Willy Tarreau55165fe2009-05-10 12:02:55 +02006442 Examples :
6443 # Original Destination address
6444 frontend www
6445 mode http
6446 option originalto except 127.0.0.1
6447
6448 # Those servers want the IP Address in X-Client-Dst
6449 backend www
6450 mode http
6451 option originalto header X-Client-Dst
6452
Willy Tarreau87cf5142011-08-19 22:57:24 +02006453 See also : "option httpclose", "option http-server-close",
6454 "option forceclose"
Willy Tarreau55165fe2009-05-10 12:02:55 +02006455
6456
Willy Tarreaua453bdd2008-01-08 19:50:52 +01006457option persist
6458no option persist
6459 Enable or disable forced persistence on down servers
6460 May be used in sections: defaults | frontend | listen | backend
6461 yes | no | yes | yes
Willy Tarreaueabeafa2008-01-16 16:17:06 +01006462 Arguments : none
Willy Tarreaua453bdd2008-01-08 19:50:52 +01006463
6464 When an HTTP request reaches a backend with a cookie which references a dead
6465 server, by default it is redispatched to another server. It is possible to
6466 force the request to be sent to the dead server first using "option persist"
6467 if absolutely needed. A common use case is when servers are under extreme
6468 load and spend their time flapping. In this case, the users would still be
6469 directed to the server they opened the session on, in the hope they would be
6470 correctly served. It is recommended to use "option redispatch" in conjunction
6471 with this option so that in the event it would not be possible to connect to
6472 the server at all (server definitely dead), the client would finally be
6473 redirected to another valid server.
6474
6475 If this option has been enabled in a "defaults" section, it can be disabled
6476 in a specific instance by prepending the "no" keyword before it.
6477
Willy Tarreau4de91492010-01-22 19:10:05 +01006478 See also : "option redispatch", "retries", "force-persist"
Willy Tarreaua453bdd2008-01-08 19:50:52 +01006479
6480
Willy Tarreau0c122822013-12-15 18:49:01 +01006481option pgsql-check [ user <username> ]
6482 Use PostgreSQL health checks for server testing
6483 May be used in sections : defaults | frontend | listen | backend
6484 yes | no | yes | yes
6485 Arguments :
6486 <username> This is the username which will be used when connecting to
6487 PostgreSQL server.
6488
6489 The check sends a PostgreSQL StartupMessage and waits for either
6490 Authentication request or ErrorResponse message. It is a basic but useful
6491 test which does not produce error nor aborted connect on the server.
6492 This check is identical with the "mysql-check".
6493
6494 See also: "option httpchk"
6495
6496
Willy Tarreau9420b122013-12-15 18:58:25 +01006497option prefer-last-server
6498no option prefer-last-server
6499 Allow multiple load balanced requests to remain on the same server
6500 May be used in sections: defaults | frontend | listen | backend
6501 yes | no | yes | yes
6502 Arguments : none
6503
6504 When the load balancing algorithm in use is not deterministic, and a previous
6505 request was sent to a server to which haproxy still holds a connection, it is
6506 sometimes desirable that subsequent requests on a same session go to the same
6507 server as much as possible. Note that this is different from persistence, as
6508 we only indicate a preference which haproxy tries to apply without any form
6509 of warranty. The real use is for keep-alive connections sent to servers. When
6510 this option is used, haproxy will try to reuse the same connection that is
6511 attached to the server instead of rebalancing to another server, causing a
6512 close of the connection. This can make sense for static file servers. It does
Willy Tarreau068621e2013-12-23 15:11:25 +01006513 not make much sense to use this in combination with hashing algorithms. Note,
6514 haproxy already automatically tries to stick to a server which sends a 401 or
6515 to a proxy which sends a 407 (authentication required). This is mandatory for
6516 use with the broken NTLM authentication challenge, and significantly helps in
6517 troubleshooting some faulty applications. Option prefer-last-server might be
6518 desirable in these environments as well, to avoid redistributing the traffic
6519 after every other response.
Willy Tarreau9420b122013-12-15 18:58:25 +01006520
6521 If this option has been enabled in a "defaults" section, it can be disabled
6522 in a specific instance by prepending the "no" keyword before it.
6523
6524 See also: "option http-keep-alive"
6525
6526
Krzysztof Piotr Oledzki25b501a2008-01-06 16:36:16 +01006527option redispatch
Joseph Lynch726ab712015-05-11 23:25:34 -07006528option redispatch <interval>
Krzysztof Piotr Oledzki25b501a2008-01-06 16:36:16 +01006529no option redispatch
6530 Enable or disable session redistribution in case of connection failure
6531 May be used in sections: defaults | frontend | listen | backend
6532 yes | no | yes | yes
Joseph Lynch726ab712015-05-11 23:25:34 -07006533 Arguments :
6534 <interval> The optional integer value that controls how often redispatches
6535 occur when retrying connections. Positive value P indicates a
6536 redispatch is desired on every Pth retry, and negative value
Davor Ocelice9ed2812017-12-25 17:49:28 +01006537 N indicate a redispatch is desired on the Nth retry prior to the
Joseph Lynch726ab712015-05-11 23:25:34 -07006538 last retry. For example, the default of -1 preserves the
Davor Ocelice9ed2812017-12-25 17:49:28 +01006539 historical behavior of redispatching on the last retry, a
Joseph Lynch726ab712015-05-11 23:25:34 -07006540 positive value of 1 would indicate a redispatch on every retry,
6541 and a positive value of 3 would indicate a redispatch on every
6542 third retry. You can disable redispatches with a value of 0.
6543
Krzysztof Piotr Oledzki25b501a2008-01-06 16:36:16 +01006544
6545 In HTTP mode, if a server designated by a cookie is down, clients may
6546 definitely stick to it because they cannot flush the cookie, so they will not
6547 be able to access the service anymore.
6548
6549 Specifying "option redispatch" will allow the proxy to break their
6550 persistence and redistribute them to a working server.
6551
Joseph Lynch726ab712015-05-11 23:25:34 -07006552 It also allows to retry connections to another server in case of multiple
Krzysztof Piotr Oledzki25b501a2008-01-06 16:36:16 +01006553 connection failures. Of course, it requires having "retries" set to a nonzero
6554 value.
Willy Tarreaud72758d2010-01-12 10:42:19 +01006555
Krzysztof Piotr Oledzki25b501a2008-01-06 16:36:16 +01006556 This form is the preferred form, which replaces both the "redispatch" and
6557 "redisp" keywords.
6558
6559 If this option has been enabled in a "defaults" section, it can be disabled
6560 in a specific instance by prepending the "no" keyword before it.
6561
Willy Tarreau4de91492010-01-22 19:10:05 +01006562 See also : "redispatch", "retries", "force-persist"
Krzysztof Piotr Oledzki25b501a2008-01-06 16:36:16 +01006563
Willy Tarreaua453bdd2008-01-08 19:50:52 +01006564
Hervé COMMOWICKec032d62011-08-05 16:23:48 +02006565option redis-check
6566 Use redis health checks for server testing
6567 May be used in sections : defaults | frontend | listen | backend
6568 yes | no | yes | yes
6569 Arguments : none
6570
6571 It is possible to test that the server correctly talks REDIS protocol instead
6572 of just testing that it accepts the TCP connection. When this option is set,
6573 a PING redis command is sent to the server, and the response is analyzed to
6574 find the "+PONG" response message.
6575
6576 Example :
6577 option redis-check
6578
Jarno Huuskonene5ae7022017-04-03 14:36:21 +03006579 See also : "option httpchk", "option tcp-check", "tcp-check expect"
Hervé COMMOWICKec032d62011-08-05 16:23:48 +02006580
6581
Willy Tarreaua453bdd2008-01-08 19:50:52 +01006582option smtpchk
6583option smtpchk <hello> <domain>
6584 Use SMTP health checks for server testing
6585 May be used in sections : defaults | frontend | listen | backend
6586 yes | no | yes | yes
Willy Tarreaud72758d2010-01-12 10:42:19 +01006587 Arguments :
Willy Tarreaua453bdd2008-01-08 19:50:52 +01006588 <hello> is an optional argument. It is the "hello" command to use. It can
6589 be either "HELO" (for SMTP) or "EHLO" (for ESTMP). All other
6590 values will be turned into the default command ("HELO").
6591
6592 <domain> is the domain name to present to the server. It may only be
6593 specified (and is mandatory) if the hello command has been
6594 specified. By default, "localhost" is used.
6595
6596 When "option smtpchk" is set, the health checks will consist in TCP
6597 connections followed by an SMTP command. By default, this command is
6598 "HELO localhost". The server's return code is analyzed and only return codes
6599 starting with a "2" will be considered as valid. All other responses,
6600 including a lack of response will constitute an error and will indicate a
6601 dead server.
6602
6603 This test is meant to be used with SMTP servers or relays. Depending on the
6604 request, it is possible that some servers do not log each connection attempt,
Davor Ocelice9ed2812017-12-25 17:49:28 +01006605 so you may want to experiment to improve the behavior. Using telnet on port
Willy Tarreaua453bdd2008-01-08 19:50:52 +01006606 25 is often easier than adjusting the configuration.
6607
6608 Most often, an incoming SMTP server needs to see the client's IP address for
6609 various purposes, including spam filtering, anti-spoofing and logging. When
6610 possible, it is often wise to masquerade the client's IP address when
6611 connecting to the server using the "usesrc" argument of the "source" keyword,
Willy Tarreau29fbe512015-08-20 19:35:14 +02006612 which requires the transparent proxy feature to be compiled in.
Willy Tarreaua453bdd2008-01-08 19:50:52 +01006613
6614 Example :
6615 option smtpchk HELO mydomain.org
6616
6617 See also : "option httpchk", "source"
6618
Krzysztof Piotr Oledzki25b501a2008-01-06 16:36:16 +01006619
Krzysztof Piotr Oledzkiaeebf9b2009-10-04 15:43:17 +02006620option socket-stats
6621no option socket-stats
6622
6623 Enable or disable collecting & providing separate statistics for each socket.
6624 May be used in sections : defaults | frontend | listen | backend
6625 yes | yes | yes | no
6626
6627 Arguments : none
6628
6629
Willy Tarreauff4f82d2009-02-06 11:28:13 +01006630option splice-auto
6631no option splice-auto
6632 Enable or disable automatic kernel acceleration on sockets in both directions
6633 May be used in sections : defaults | frontend | listen | backend
6634 yes | yes | yes | yes
6635 Arguments : none
6636
6637 When this option is enabled either on a frontend or on a backend, haproxy
6638 will automatically evaluate the opportunity to use kernel tcp splicing to
Davor Ocelice9ed2812017-12-25 17:49:28 +01006639 forward data between the client and the server, in either direction. HAProxy
Willy Tarreauff4f82d2009-02-06 11:28:13 +01006640 uses heuristics to estimate if kernel splicing might improve performance or
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +01006641 not. Both directions are handled independently. Note that the heuristics used
Willy Tarreauff4f82d2009-02-06 11:28:13 +01006642 are not much aggressive in order to limit excessive use of splicing. This
6643 option requires splicing to be enabled at compile time, and may be globally
6644 disabled with the global option "nosplice". Since splice uses pipes, using it
6645 requires that there are enough spare pipes.
6646
6647 Important note: kernel-based TCP splicing is a Linux-specific feature which
6648 first appeared in kernel 2.6.25. It offers kernel-based acceleration to
6649 transfer data between sockets without copying these data to user-space, thus
6650 providing noticeable performance gains and CPU cycles savings. Since many
6651 early implementations are buggy, corrupt data and/or are inefficient, this
6652 feature is not enabled by default, and it should be used with extreme care.
6653 While it is not possible to detect the correctness of an implementation,
6654 2.6.29 is the first version offering a properly working implementation. In
6655 case of doubt, splicing may be globally disabled using the global "nosplice"
6656 keyword.
6657
6658 Example :
6659 option splice-auto
6660
6661 If this option has been enabled in a "defaults" section, it can be disabled
6662 in a specific instance by prepending the "no" keyword before it.
6663
6664 See also : "option splice-request", "option splice-response", and global
6665 options "nosplice" and "maxpipes"
6666
6667
6668option splice-request
6669no option splice-request
6670 Enable or disable automatic kernel acceleration on sockets for requests
6671 May be used in sections : defaults | frontend | listen | backend
6672 yes | yes | yes | yes
6673 Arguments : none
6674
6675 When this option is enabled either on a frontend or on a backend, haproxy
Jamie Gloudonaaa21002012-08-25 00:18:33 -04006676 will use kernel tcp splicing whenever possible to forward data going from
Willy Tarreauff4f82d2009-02-06 11:28:13 +01006677 the client to the server. It might still use the recv/send scheme if there
6678 are no spare pipes left. This option requires splicing to be enabled at
6679 compile time, and may be globally disabled with the global option "nosplice".
6680 Since splice uses pipes, using it requires that there are enough spare pipes.
6681
6682 Important note: see "option splice-auto" for usage limitations.
6683
6684 Example :
6685 option splice-request
6686
6687 If this option has been enabled in a "defaults" section, it can be disabled
6688 in a specific instance by prepending the "no" keyword before it.
6689
6690 See also : "option splice-auto", "option splice-response", and global options
6691 "nosplice" and "maxpipes"
6692
6693
6694option splice-response
6695no option splice-response
6696 Enable or disable automatic kernel acceleration on sockets for responses
6697 May be used in sections : defaults | frontend | listen | backend
6698 yes | yes | yes | yes
6699 Arguments : none
6700
6701 When this option is enabled either on a frontend or on a backend, haproxy
Jamie Gloudonaaa21002012-08-25 00:18:33 -04006702 will use kernel tcp splicing whenever possible to forward data going from
Willy Tarreauff4f82d2009-02-06 11:28:13 +01006703 the server to the client. It might still use the recv/send scheme if there
6704 are no spare pipes left. This option requires splicing to be enabled at
6705 compile time, and may be globally disabled with the global option "nosplice".
6706 Since splice uses pipes, using it requires that there are enough spare pipes.
6707
6708 Important note: see "option splice-auto" for usage limitations.
6709
6710 Example :
6711 option splice-response
6712
6713 If this option has been enabled in a "defaults" section, it can be disabled
6714 in a specific instance by prepending the "no" keyword before it.
6715
6716 See also : "option splice-auto", "option splice-request", and global options
6717 "nosplice" and "maxpipes"
6718
6719
Christopher Fauletba7bc162016-11-07 21:07:38 +01006720option spop-check
6721 Use SPOP health checks for server testing
6722 May be used in sections : defaults | frontend | listen | backend
6723 no | no | no | yes
6724 Arguments : none
6725
6726 It is possible to test that the server correctly talks SPOP protocol instead
6727 of just testing that it accepts the TCP connection. When this option is set,
6728 a HELLO handshake is performed between HAProxy and the server, and the
6729 response is analyzed to check no error is reported.
6730
6731 Example :
6732 option spop-check
6733
6734 See also : "option httpchk"
6735
6736
Willy Tarreaubf1f8162007-12-28 17:42:56 +01006737option srvtcpka
6738no option srvtcpka
6739 Enable or disable the sending of TCP keepalive packets on the server side
6740 May be used in sections : defaults | frontend | listen | backend
6741 yes | no | yes | yes
6742 Arguments : none
6743
6744 When there is a firewall or any session-aware component between a client and
6745 a server, and when the protocol involves very long sessions with long idle
Davor Ocelice9ed2812017-12-25 17:49:28 +01006746 periods (e.g. remote desktops), there is a risk that one of the intermediate
Willy Tarreaubf1f8162007-12-28 17:42:56 +01006747 components decides to expire a session which has remained idle for too long.
6748
6749 Enabling socket-level TCP keep-alives makes the system regularly send packets
6750 to the other end of the connection, leaving it active. The delay between
6751 keep-alive probes is controlled by the system only and depends both on the
6752 operating system and its tuning parameters.
6753
6754 It is important to understand that keep-alive packets are neither emitted nor
6755 received at the application level. It is only the network stacks which sees
6756 them. For this reason, even if one side of the proxy already uses keep-alives
6757 to maintain its connection alive, those keep-alive packets will not be
6758 forwarded to the other side of the proxy.
6759
6760 Please note that this has nothing to do with HTTP keep-alive.
6761
6762 Using option "srvtcpka" enables the emission of TCP keep-alive probes on the
6763 server side of a connection, which should help when session expirations are
6764 noticed between HAProxy and a server.
6765
6766 If this option has been enabled in a "defaults" section, it can be disabled
6767 in a specific instance by prepending the "no" keyword before it.
6768
6769 See also : "option clitcpka", "option tcpka"
6770
6771
Willy Tarreaua453bdd2008-01-08 19:50:52 +01006772option ssl-hello-chk
6773 Use SSLv3 client hello health checks for server testing
6774 May be used in sections : defaults | frontend | listen | backend
6775 yes | no | yes | yes
6776 Arguments : none
6777
6778 When some SSL-based protocols are relayed in TCP mode through HAProxy, it is
6779 possible to test that the server correctly talks SSL instead of just testing
6780 that it accepts the TCP connection. When "option ssl-hello-chk" is set, pure
6781 SSLv3 client hello messages are sent once the connection is established to
6782 the server, and the response is analyzed to find an SSL server hello message.
6783 The server is considered valid only when the response contains this server
6784 hello message.
6785
6786 All servers tested till there correctly reply to SSLv3 client hello messages,
6787 and most servers tested do not even log the requests containing only hello
6788 messages, which is appreciable.
6789
Willy Tarreau763a95b2012-10-04 23:15:39 +02006790 Note that this check works even when SSL support was not built into haproxy
6791 because it forges the SSL message. When SSL support is available, it is best
6792 to use native SSL health checks instead of this one.
Willy Tarreaua453bdd2008-01-08 19:50:52 +01006793
Willy Tarreau763a95b2012-10-04 23:15:39 +02006794 See also: "option httpchk", "check-ssl"
6795
Willy Tarreaua453bdd2008-01-08 19:50:52 +01006796
Willy Tarreaued179852013-12-16 01:07:00 +01006797option tcp-check
6798 Perform health checks using tcp-check send/expect sequences
6799 May be used in sections: defaults | frontend | listen | backend
6800 yes | no | yes | yes
6801
6802 This health check method is intended to be combined with "tcp-check" command
6803 lists in order to support send/expect types of health check sequences.
6804
6805 TCP checks currently support 4 modes of operations :
6806 - no "tcp-check" directive : the health check only consists in a connection
6807 attempt, which remains the default mode.
6808
Jarno Huuskonen0e82b922014-04-12 18:22:19 +03006809 - "tcp-check send" or "tcp-check send-binary" only is mentioned : this is
Willy Tarreaued179852013-12-16 01:07:00 +01006810 used to send a string along with a connection opening. With some
6811 protocols, it helps sending a "QUIT" message for example that prevents
6812 the server from logging a connection error for each health check. The
6813 check result will still be based on the ability to open the connection
6814 only.
6815
Jarno Huuskonen0e82b922014-04-12 18:22:19 +03006816 - "tcp-check expect" only is mentioned : this is used to test a banner.
Willy Tarreaued179852013-12-16 01:07:00 +01006817 The connection is opened and haproxy waits for the server to present some
6818 contents which must validate some rules. The check result will be based
6819 on the matching between the contents and the rules. This is suited for
6820 POP, IMAP, SMTP, FTP, SSH, TELNET.
6821
Jarno Huuskonen0e82b922014-04-12 18:22:19 +03006822 - both "tcp-check send" and "tcp-check expect" are mentioned : this is
Davor Ocelice9ed2812017-12-25 17:49:28 +01006823 used to test a hello-type protocol. HAProxy sends a message, the server
6824 responds and its response is analyzed. the check result will be based on
Jarno Huuskonen0e82b922014-04-12 18:22:19 +03006825 the matching between the response contents and the rules. This is often
Willy Tarreaued179852013-12-16 01:07:00 +01006826 suited for protocols which require a binding or a request/response model.
6827 LDAP, MySQL, Redis and SSL are example of such protocols, though they
6828 already all have their dedicated checks with a deeper understanding of
6829 the respective protocols.
6830 In this mode, many questions may be sent and many answers may be
Davor Ocelice9ed2812017-12-25 17:49:28 +01006831 analyzed.
Willy Tarreaued179852013-12-16 01:07:00 +01006832
Baptiste Assmannd60a9e52015-04-25 16:27:23 +02006833 A fifth mode can be used to insert comments in different steps of the
6834 script.
6835
6836 For each tcp-check rule you create, you can add a "comment" directive,
6837 followed by a string. This string will be reported in the log and stderr
6838 in debug mode. It is useful to make user-friendly error reporting.
6839 The "comment" is of course optional.
6840
6841
Willy Tarreaued179852013-12-16 01:07:00 +01006842 Examples :
Davor Ocelice9ed2812017-12-25 17:49:28 +01006843 # perform a POP check (analyze only server's banner)
Willy Tarreaued179852013-12-16 01:07:00 +01006844 option tcp-check
Baptiste Assmannd60a9e52015-04-25 16:27:23 +02006845 tcp-check expect string +OK\ POP3\ ready comment POP\ protocol
Willy Tarreaued179852013-12-16 01:07:00 +01006846
Davor Ocelice9ed2812017-12-25 17:49:28 +01006847 # perform an IMAP check (analyze only server's banner)
Willy Tarreaued179852013-12-16 01:07:00 +01006848 option tcp-check
Baptiste Assmannd60a9e52015-04-25 16:27:23 +02006849 tcp-check expect string *\ OK\ IMAP4\ ready comment IMAP\ protocol
Willy Tarreaued179852013-12-16 01:07:00 +01006850
6851 # look for the redis master server after ensuring it speaks well
6852 # redis protocol, then it exits properly.
Davor Ocelice9ed2812017-12-25 17:49:28 +01006853 # (send a command then analyze the response 3 times)
Willy Tarreaued179852013-12-16 01:07:00 +01006854 option tcp-check
Baptiste Assmannd60a9e52015-04-25 16:27:23 +02006855 tcp-check comment PING\ phase
Willy Tarreaued179852013-12-16 01:07:00 +01006856 tcp-check send PING\r\n
Baptiste Assmanna3322992015-08-04 10:12:18 +02006857 tcp-check expect string +PONG
Baptiste Assmannd60a9e52015-04-25 16:27:23 +02006858 tcp-check comment role\ check
Willy Tarreaued179852013-12-16 01:07:00 +01006859 tcp-check send info\ replication\r\n
6860 tcp-check expect string role:master
Baptiste Assmannd60a9e52015-04-25 16:27:23 +02006861 tcp-check comment QUIT\ phase
Willy Tarreaued179852013-12-16 01:07:00 +01006862 tcp-check send QUIT\r\n
6863 tcp-check expect string +OK
6864
Davor Ocelice9ed2812017-12-25 17:49:28 +01006865 forge a HTTP request, then analyze the response
Willy Tarreaued179852013-12-16 01:07:00 +01006866 (send many headers before analyzing)
6867 option tcp-check
Baptiste Assmannd60a9e52015-04-25 16:27:23 +02006868 tcp-check comment forge\ and\ send\ HTTP\ request
Willy Tarreaued179852013-12-16 01:07:00 +01006869 tcp-check send HEAD\ /\ HTTP/1.1\r\n
6870 tcp-check send Host:\ www.mydomain.com\r\n
6871 tcp-check send User-Agent:\ HAProxy\ tcpcheck\r\n
6872 tcp-check send \r\n
Baptiste Assmannd60a9e52015-04-25 16:27:23 +02006873 tcp-check expect rstring HTTP/1\..\ (2..|3..) comment check\ HTTP\ response
Willy Tarreaued179852013-12-16 01:07:00 +01006874
6875
6876 See also : "tcp-check expect", "tcp-check send"
6877
6878
Willy Tarreau9ea05a72009-06-14 12:07:01 +02006879option tcp-smart-accept
6880no option tcp-smart-accept
6881 Enable or disable the saving of one ACK packet during the accept sequence
6882 May be used in sections : defaults | frontend | listen | backend
6883 yes | yes | yes | no
6884 Arguments : none
6885
6886 When an HTTP connection request comes in, the system acknowledges it on
6887 behalf of HAProxy, then the client immediately sends its request, and the
6888 system acknowledges it too while it is notifying HAProxy about the new
6889 connection. HAProxy then reads the request and responds. This means that we
6890 have one TCP ACK sent by the system for nothing, because the request could
6891 very well be acknowledged by HAProxy when it sends its response.
6892
6893 For this reason, in HTTP mode, HAProxy automatically asks the system to avoid
6894 sending this useless ACK on platforms which support it (currently at least
6895 Linux). It must not cause any problem, because the system will send it anyway
6896 after 40 ms if the response takes more time than expected to come.
6897
6898 During complex network debugging sessions, it may be desirable to disable
6899 this optimization because delayed ACKs can make troubleshooting more complex
6900 when trying to identify where packets are delayed. It is then possible to
Davor Ocelice9ed2812017-12-25 17:49:28 +01006901 fall back to normal behavior by specifying "no option tcp-smart-accept".
Willy Tarreau9ea05a72009-06-14 12:07:01 +02006902
6903 It is also possible to force it for non-HTTP proxies by simply specifying
6904 "option tcp-smart-accept". For instance, it can make sense with some services
6905 such as SMTP where the server speaks first.
6906
6907 It is recommended to avoid forcing this option in a defaults section. In case
6908 of doubt, consider setting it back to automatic values by prepending the
6909 "default" keyword before it, or disabling it using the "no" keyword.
6910
Willy Tarreaud88edf22009-06-14 15:48:17 +02006911 See also : "option tcp-smart-connect"
6912
6913
6914option tcp-smart-connect
6915no option tcp-smart-connect
6916 Enable or disable the saving of one ACK packet during the connect sequence
6917 May be used in sections : defaults | frontend | listen | backend
6918 yes | no | yes | yes
6919 Arguments : none
6920
6921 On certain systems (at least Linux), HAProxy can ask the kernel not to
6922 immediately send an empty ACK upon a connection request, but to directly
6923 send the buffer request instead. This saves one packet on the network and
6924 thus boosts performance. It can also be useful for some servers, because they
6925 immediately get the request along with the incoming connection.
6926
6927 This feature is enabled when "option tcp-smart-connect" is set in a backend.
6928 It is not enabled by default because it makes network troubleshooting more
6929 complex.
6930
6931 It only makes sense to enable it with protocols where the client speaks first
6932 such as HTTP. In other situations, if there is no data to send in place of
6933 the ACK, a normal ACK is sent.
6934
6935 If this option has been enabled in a "defaults" section, it can be disabled
6936 in a specific instance by prepending the "no" keyword before it.
6937
6938 See also : "option tcp-smart-accept"
6939
Willy Tarreau9ea05a72009-06-14 12:07:01 +02006940
Willy Tarreaubf1f8162007-12-28 17:42:56 +01006941option tcpka
6942 Enable or disable the sending of TCP keepalive packets on both sides
6943 May be used in sections : defaults | frontend | listen | backend
6944 yes | yes | yes | yes
6945 Arguments : none
6946
6947 When there is a firewall or any session-aware component between a client and
6948 a server, and when the protocol involves very long sessions with long idle
Davor Ocelice9ed2812017-12-25 17:49:28 +01006949 periods (e.g. remote desktops), there is a risk that one of the intermediate
Willy Tarreaubf1f8162007-12-28 17:42:56 +01006950 components decides to expire a session which has remained idle for too long.
6951
6952 Enabling socket-level TCP keep-alives makes the system regularly send packets
6953 to the other end of the connection, leaving it active. The delay between
6954 keep-alive probes is controlled by the system only and depends both on the
6955 operating system and its tuning parameters.
6956
6957 It is important to understand that keep-alive packets are neither emitted nor
6958 received at the application level. It is only the network stacks which sees
6959 them. For this reason, even if one side of the proxy already uses keep-alives
6960 to maintain its connection alive, those keep-alive packets will not be
6961 forwarded to the other side of the proxy.
6962
6963 Please note that this has nothing to do with HTTP keep-alive.
6964
6965 Using option "tcpka" enables the emission of TCP keep-alive probes on both
6966 the client and server sides of a connection. Note that this is meaningful
6967 only in "defaults" or "listen" sections. If this option is used in a
6968 frontend, only the client side will get keep-alives, and if this option is
6969 used in a backend, only the server side will get keep-alives. For this
6970 reason, it is strongly recommended to explicitly use "option clitcpka" and
6971 "option srvtcpka" when the configuration is split between frontends and
6972 backends.
6973
6974 See also : "option clitcpka", "option srvtcpka"
6975
Willy Tarreau844e3c52008-01-11 16:28:18 +01006976
6977option tcplog
6978 Enable advanced logging of TCP connections with session state and timers
6979 May be used in sections : defaults | frontend | listen | backend
Tim Duesterhus9ad9f352018-02-05 20:52:27 +01006980 yes | yes | yes | no
Willy Tarreau844e3c52008-01-11 16:28:18 +01006981 Arguments : none
6982
6983 By default, the log output format is very poor, as it only contains the
6984 source and destination addresses, and the instance name. By specifying
6985 "option tcplog", each log line turns into a much richer format including, but
6986 not limited to, the connection timers, the session status, the connections
6987 numbers, the frontend, backend and server name, and of course the source
6988 address and ports. This option is useful for pure TCP proxies in order to
6989 find which of the client or server disconnects or times out. For normal HTTP
6990 proxies, it's better to use "option httplog" which is even more complete.
6991
Guillaume de Lafond29f45602017-03-31 19:52:15 +02006992 "option tcplog" overrides any previous "log-format" directive.
6993
Willy Tarreauc57f0e22009-05-10 13:12:33 +02006994 See also : "option httplog", and section 8 about logging.
Willy Tarreau844e3c52008-01-11 16:28:18 +01006995
6996
Willy Tarreau844e3c52008-01-11 16:28:18 +01006997option transparent
6998no option transparent
6999 Enable client-side transparent proxying
7000 May be used in sections : defaults | frontend | listen | backend
Willy Tarreau4b1f8592008-12-23 23:13:55 +01007001 yes | no | yes | yes
Willy Tarreau844e3c52008-01-11 16:28:18 +01007002 Arguments : none
7003
7004 This option was introduced in order to provide layer 7 persistence to layer 3
7005 load balancers. The idea is to use the OS's ability to redirect an incoming
7006 connection for a remote address to a local process (here HAProxy), and let
7007 this process know what address was initially requested. When this option is
7008 used, sessions without cookies will be forwarded to the original destination
7009 IP address of the incoming request (which should match that of another
7010 equipment), while requests with cookies will still be forwarded to the
7011 appropriate server.
7012
7013 Note that contrary to a common belief, this option does NOT make HAProxy
7014 present the client's IP to the server when establishing the connection.
7015
Willy Tarreaua1146052011-03-01 09:51:54 +01007016 See also: the "usesrc" argument of the "source" keyword, and the
Willy Tarreaueabeafa2008-01-16 16:17:06 +01007017 "transparent" option of the "bind" keyword.
Willy Tarreau844e3c52008-01-11 16:28:18 +01007018
Willy Tarreaubf1f8162007-12-28 17:42:56 +01007019
Simon Horman98637e52014-06-20 12:30:16 +09007020external-check command <command>
7021 Executable to run when performing an external-check
7022 May be used in sections : defaults | frontend | listen | backend
7023 yes | no | yes | yes
7024
7025 Arguments :
7026 <command> is the external command to run
7027
Simon Horman98637e52014-06-20 12:30:16 +09007028 The arguments passed to the to the command are:
7029
Cyril Bonté777be862014-12-02 21:21:35 +01007030 <proxy_address> <proxy_port> <server_address> <server_port>
Simon Horman98637e52014-06-20 12:30:16 +09007031
Cyril Bonté777be862014-12-02 21:21:35 +01007032 The <proxy_address> and <proxy_port> are derived from the first listener
7033 that is either IPv4, IPv6 or a UNIX socket. In the case of a UNIX socket
7034 listener the proxy_address will be the path of the socket and the
7035 <proxy_port> will be the string "NOT_USED". In a backend section, it's not
7036 possible to determine a listener, and both <proxy_address> and <proxy_port>
7037 will have the string value "NOT_USED".
Simon Horman98637e52014-06-20 12:30:16 +09007038
Cyril Bonté72cda2a2014-12-27 22:28:39 +01007039 Some values are also provided through environment variables.
7040
7041 Environment variables :
7042 HAPROXY_PROXY_ADDR The first bind address if available (or empty if not
7043 applicable, for example in a "backend" section).
7044
7045 HAPROXY_PROXY_ID The backend id.
7046
7047 HAPROXY_PROXY_NAME The backend name.
7048
7049 HAPROXY_PROXY_PORT The first bind port if available (or empty if not
7050 applicable, for example in a "backend" section or
7051 for a UNIX socket).
7052
7053 HAPROXY_SERVER_ADDR The server address.
7054
7055 HAPROXY_SERVER_CURCONN The current number of connections on the server.
7056
7057 HAPROXY_SERVER_ID The server id.
7058
7059 HAPROXY_SERVER_MAXCONN The server max connections.
7060
7061 HAPROXY_SERVER_NAME The server name.
7062
7063 HAPROXY_SERVER_PORT The server port if available (or empty for a UNIX
7064 socket).
7065
7066 PATH The PATH environment variable used when executing
7067 the command may be set using "external-check path".
7068
Simon Horman98637e52014-06-20 12:30:16 +09007069 If the command executed and exits with a zero status then the check is
7070 considered to have passed, otherwise the check is considered to have
7071 failed.
7072
7073 Example :
7074 external-check command /bin/true
7075
7076 See also : "external-check", "option external-check", "external-check path"
7077
7078
7079external-check path <path>
7080 The value of the PATH environment variable used when running an external-check
7081 May be used in sections : defaults | frontend | listen | backend
7082 yes | no | yes | yes
7083
7084 Arguments :
7085 <path> is the path used when executing external command to run
7086
7087 The default path is "".
7088
7089 Example :
7090 external-check path "/usr/bin:/bin"
7091
7092 See also : "external-check", "option external-check",
7093 "external-check command"
7094
7095
Emeric Brun647caf12009-06-30 17:57:00 +02007096persist rdp-cookie
Hervé COMMOWICKa3eb39c2011-08-05 18:48:51 +02007097persist rdp-cookie(<name>)
Emeric Brun647caf12009-06-30 17:57:00 +02007098 Enable RDP cookie-based persistence
7099 May be used in sections : defaults | frontend | listen | backend
7100 yes | no | yes | yes
7101 Arguments :
7102 <name> is the optional name of the RDP cookie to check. If omitted, the
Willy Tarreau61e28f22010-05-16 22:31:05 +02007103 default cookie name "msts" will be used. There currently is no
7104 valid reason to change this name.
Emeric Brun647caf12009-06-30 17:57:00 +02007105
7106 This statement enables persistence based on an RDP cookie. The RDP cookie
7107 contains all information required to find the server in the list of known
Davor Ocelice9ed2812017-12-25 17:49:28 +01007108 servers. So when this option is set in the backend, the request is analyzed
Emeric Brun647caf12009-06-30 17:57:00 +02007109 and if an RDP cookie is found, it is decoded. If it matches a known server
7110 which is still UP (or if "option persist" is set), then the connection is
7111 forwarded to this server.
7112
7113 Note that this only makes sense in a TCP backend, but for this to work, the
7114 frontend must have waited long enough to ensure that an RDP cookie is present
7115 in the request buffer. This is the same requirement as with the "rdp-cookie"
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +01007116 load-balancing method. Thus it is highly recommended to put all statements in
Emeric Brun647caf12009-06-30 17:57:00 +02007117 a single "listen" section.
7118
Willy Tarreau61e28f22010-05-16 22:31:05 +02007119 Also, it is important to understand that the terminal server will emit this
7120 RDP cookie only if it is configured for "token redirection mode", which means
7121 that the "IP address redirection" option is disabled.
7122
Emeric Brun647caf12009-06-30 17:57:00 +02007123 Example :
7124 listen tse-farm
7125 bind :3389
7126 # wait up to 5s for an RDP cookie in the request
7127 tcp-request inspect-delay 5s
7128 tcp-request content accept if RDP_COOKIE
7129 # apply RDP cookie persistence
7130 persist rdp-cookie
7131 # if server is unknown, let's balance on the same cookie.
Cyril Bontédc4d9032012-04-08 21:57:39 +02007132 # alternatively, "balance leastconn" may be useful too.
Emeric Brun647caf12009-06-30 17:57:00 +02007133 balance rdp-cookie
7134 server srv1 1.1.1.1:3389
7135 server srv2 1.1.1.2:3389
7136
Simon Hormanab814e02011-06-24 14:50:20 +09007137 See also : "balance rdp-cookie", "tcp-request", the "req_rdp_cookie" ACL and
7138 the rdp_cookie pattern fetch function.
Emeric Brun647caf12009-06-30 17:57:00 +02007139
7140
Willy Tarreau3a7d2072009-03-05 23:48:25 +01007141rate-limit sessions <rate>
7142 Set a limit on the number of new sessions accepted per second on a frontend
7143 May be used in sections : defaults | frontend | listen | backend
7144 yes | yes | yes | no
7145 Arguments :
7146 <rate> The <rate> parameter is an integer designating the maximum number
7147 of new sessions per second to accept on the frontend.
7148
7149 When the frontend reaches the specified number of new sessions per second, it
7150 stops accepting new connections until the rate drops below the limit again.
7151 During this time, the pending sessions will be kept in the socket's backlog
7152 (in system buffers) and haproxy will not even be aware that sessions are
7153 pending. When applying very low limit on a highly loaded service, it may make
7154 sense to increase the socket's backlog using the "backlog" keyword.
7155
7156 This feature is particularly efficient at blocking connection-based attacks
7157 or service abuse on fragile servers. Since the session rate is measured every
7158 millisecond, it is extremely accurate. Also, the limit applies immediately,
7159 no delay is needed at all to detect the threshold.
7160
7161 Example : limit the connection rate on SMTP to 10 per second max
7162 listen smtp
7163 mode tcp
7164 bind :25
7165 rate-limit sessions 10
Panagiotis Panagiotopoulos7282d8e2016-02-11 16:37:15 +02007166 server smtp1 127.0.0.1:1025
Willy Tarreau3a7d2072009-03-05 23:48:25 +01007167
Willy Tarreaua17c2d92011-07-25 08:16:20 +02007168 Note : when the maximum rate is reached, the frontend's status is not changed
7169 but its sockets appear as "WAITING" in the statistics if the
7170 "socket-stats" option is enabled.
Willy Tarreau3a7d2072009-03-05 23:48:25 +01007171
7172 See also : the "backlog" keyword and the "fe_sess_rate" ACL criterion.
7173
7174
Willy Tarreau2e1dca82012-09-12 08:43:15 +02007175redirect location <loc> [code <code>] <option> [{if | unless} <condition>]
7176redirect prefix <pfx> [code <code>] <option> [{if | unless} <condition>]
7177redirect scheme <sch> [code <code>] <option> [{if | unless} <condition>]
Willy Tarreaub463dfb2008-06-07 23:08:56 +02007178 Return an HTTP redirection if/unless a condition is matched
7179 May be used in sections : defaults | frontend | listen | backend
7180 no | yes | yes | yes
7181
7182 If/unless the condition is matched, the HTTP request will lead to a redirect
Willy Tarreauf285f542010-01-03 20:03:03 +01007183 response. If no condition is specified, the redirect applies unconditionally.
Willy Tarreaub463dfb2008-06-07 23:08:56 +02007184
Willy Tarreau0140f252008-11-19 21:07:09 +01007185 Arguments :
Willy Tarreau2e1dca82012-09-12 08:43:15 +02007186 <loc> With "redirect location", the exact value in <loc> is placed into
Thierry FOURNIERd18cd0f2013-11-29 12:15:45 +01007187 the HTTP "Location" header. When used in an "http-request" rule,
7188 <loc> value follows the log-format rules and can include some
7189 dynamic values (see Custom Log Format in section 8.2.4).
Willy Tarreau2e1dca82012-09-12 08:43:15 +02007190
7191 <pfx> With "redirect prefix", the "Location" header is built from the
7192 concatenation of <pfx> and the complete URI path, including the
7193 query string, unless the "drop-query" option is specified (see
7194 below). As a special case, if <pfx> equals exactly "/", then
7195 nothing is inserted before the original URI. It allows one to
Thierry FOURNIERd18cd0f2013-11-29 12:15:45 +01007196 redirect to the same URL (for instance, to insert a cookie). When
7197 used in an "http-request" rule, <pfx> value follows the log-format
7198 rules and can include some dynamic values (see Custom Log Format
7199 in section 8.2.4).
Willy Tarreau2e1dca82012-09-12 08:43:15 +02007200
7201 <sch> With "redirect scheme", then the "Location" header is built by
7202 concatenating <sch> with "://" then the first occurrence of the
7203 "Host" header, and then the URI path, including the query string
7204 unless the "drop-query" option is specified (see below). If no
7205 path is found or if the path is "*", then "/" is used instead. If
7206 no "Host" header is found, then an empty host component will be
Jarno Huuskonen0e82b922014-04-12 18:22:19 +03007207 returned, which most recent browsers interpret as redirecting to
Willy Tarreau2e1dca82012-09-12 08:43:15 +02007208 the same host. This directive is mostly used to redirect HTTP to
Thierry FOURNIERd18cd0f2013-11-29 12:15:45 +01007209 HTTPS. When used in an "http-request" rule, <sch> value follows
7210 the log-format rules and can include some dynamic values (see
7211 Custom Log Format in section 8.2.4).
Willy Tarreau0140f252008-11-19 21:07:09 +01007212
7213 <code> The code is optional. It indicates which type of HTTP redirection
Willy Tarreaub67fdc42013-03-29 19:28:11 +01007214 is desired. Only codes 301, 302, 303, 307 and 308 are supported,
7215 with 302 used by default if no code is specified. 301 means
7216 "Moved permanently", and a browser may cache the Location. 302
Baptiste Assmannea849c02015-08-03 11:42:50 +02007217 means "Moved temporarily" and means that the browser should not
Willy Tarreaub67fdc42013-03-29 19:28:11 +01007218 cache the redirection. 303 is equivalent to 302 except that the
7219 browser will fetch the location with a GET method. 307 is just
7220 like 302 but makes it clear that the same method must be reused.
7221 Likewise, 308 replaces 301 if the same method must be used.
Willy Tarreau0140f252008-11-19 21:07:09 +01007222
7223 <option> There are several options which can be specified to adjust the
Davor Ocelice9ed2812017-12-25 17:49:28 +01007224 expected behavior of a redirection :
Willy Tarreau0140f252008-11-19 21:07:09 +01007225
7226 - "drop-query"
7227 When this keyword is used in a prefix-based redirection, then the
7228 location will be set without any possible query-string, which is useful
7229 for directing users to a non-secure page for instance. It has no effect
7230 with a location-type redirect.
7231
Willy Tarreau81e3b4f2010-01-10 00:42:19 +01007232 - "append-slash"
7233 This keyword may be used in conjunction with "drop-query" to redirect
7234 users who use a URL not ending with a '/' to the same one with the '/'.
7235 It can be useful to ensure that search engines will only see one URL.
7236 For this, a return code 301 is preferred.
7237
Willy Tarreau0140f252008-11-19 21:07:09 +01007238 - "set-cookie NAME[=value]"
7239 A "Set-Cookie" header will be added with NAME (and optionally "=value")
7240 to the response. This is sometimes used to indicate that a user has
7241 been seen, for instance to protect against some types of DoS. No other
7242 cookie option is added, so the cookie will be a session cookie. Note
7243 that for a browser, a sole cookie name without an equal sign is
7244 different from a cookie with an equal sign.
7245
7246 - "clear-cookie NAME[=]"
7247 A "Set-Cookie" header will be added with NAME (and optionally "="), but
7248 with the "Max-Age" attribute set to zero. This will tell the browser to
7249 delete this cookie. It is useful for instance on logout pages. It is
7250 important to note that clearing the cookie "NAME" will not remove a
7251 cookie set with "NAME=value". You have to clear the cookie "NAME=" for
7252 that, because the browser makes the difference.
Willy Tarreaub463dfb2008-06-07 23:08:56 +02007253
7254 Example: move the login URL only to HTTPS.
7255 acl clear dst_port 80
7256 acl secure dst_port 8080
7257 acl login_page url_beg /login
Willy Tarreau0140f252008-11-19 21:07:09 +01007258 acl logout url_beg /logout
Willy Tarreau79da4692008-11-19 20:03:04 +01007259 acl uid_given url_reg /login?userid=[^&]+
Willy Tarreau0140f252008-11-19 21:07:09 +01007260 acl cookie_set hdr_sub(cookie) SEEN=1
7261
7262 redirect prefix https://mysite.com set-cookie SEEN=1 if !cookie_set
Willy Tarreau79da4692008-11-19 20:03:04 +01007263 redirect prefix https://mysite.com if login_page !secure
7264 redirect prefix http://mysite.com drop-query if login_page !uid_given
7265 redirect location http://mysite.com/ if !login_page secure
Willy Tarreau0140f252008-11-19 21:07:09 +01007266 redirect location / clear-cookie USERID= if logout
Willy Tarreaub463dfb2008-06-07 23:08:56 +02007267
Willy Tarreau81e3b4f2010-01-10 00:42:19 +01007268 Example: send redirects for request for articles without a '/'.
7269 acl missing_slash path_reg ^/article/[^/]*$
7270 redirect code 301 prefix / drop-query append-slash if missing_slash
7271
Willy Tarreau2e1dca82012-09-12 08:43:15 +02007272 Example: redirect all HTTP traffic to HTTPS when SSL is handled by haproxy.
David BERARDe7153042012-11-03 00:11:31 +01007273 redirect scheme https if !{ ssl_fc }
Willy Tarreau2e1dca82012-09-12 08:43:15 +02007274
Thierry FOURNIERd18cd0f2013-11-29 12:15:45 +01007275 Example: append 'www.' prefix in front of all hosts not having it
Coen Rosdorff596659b2016-04-11 11:33:49 +02007276 http-request redirect code 301 location \
7277 http://www.%[hdr(host)]%[capture.req.uri] \
7278 unless { hdr_beg(host) -i www }
Thierry FOURNIERd18cd0f2013-11-29 12:15:45 +01007279
Willy Tarreauc57f0e22009-05-10 13:12:33 +02007280 See section 7 about ACL usage.
Willy Tarreaub463dfb2008-06-07 23:08:56 +02007281
7282
Krzysztof Piotr Oledzki25b501a2008-01-06 16:36:16 +01007283redisp (deprecated)
7284redispatch (deprecated)
7285 Enable or disable session redistribution in case of connection failure
7286 May be used in sections: defaults | frontend | listen | backend
7287 yes | no | yes | yes
Willy Tarreaueabeafa2008-01-16 16:17:06 +01007288 Arguments : none
Krzysztof Piotr Oledzki25b501a2008-01-06 16:36:16 +01007289
7290 In HTTP mode, if a server designated by a cookie is down, clients may
7291 definitely stick to it because they cannot flush the cookie, so they will not
7292 be able to access the service anymore.
7293
7294 Specifying "redispatch" will allow the proxy to break their persistence and
7295 redistribute them to a working server.
7296
7297 It also allows to retry last connection to another server in case of multiple
7298 connection failures. Of course, it requires having "retries" set to a nonzero
7299 value.
Willy Tarreaud72758d2010-01-12 10:42:19 +01007300
Krzysztof Piotr Oledzki25b501a2008-01-06 16:36:16 +01007301 This form is deprecated, do not use it in any new configuration, use the new
7302 "option redispatch" instead.
7303
7304 See also : "option redispatch"
7305
Willy Tarreaueabeafa2008-01-16 16:17:06 +01007306
Willy Tarreau8abd4cd2010-01-31 14:30:44 +01007307reqadd <string> [{if | unless} <cond>]
Willy Tarreau303c0352008-01-17 19:01:39 +01007308 Add a header at the end of the HTTP request
7309 May be used in sections : defaults | frontend | listen | backend
7310 no | yes | yes | yes
7311 Arguments :
7312 <string> is the complete line to be added. Any space or known delimiter
7313 must be escaped using a backslash ('\'). Please refer to section
Willy Tarreauc57f0e22009-05-10 13:12:33 +02007314 6 about HTTP header manipulation for more information.
Willy Tarreau303c0352008-01-17 19:01:39 +01007315
Willy Tarreau8abd4cd2010-01-31 14:30:44 +01007316 <cond> is an optional matching condition built from ACLs. It makes it
7317 possible to ignore this rule when other conditions are not met.
7318
Willy Tarreau303c0352008-01-17 19:01:39 +01007319 A new line consisting in <string> followed by a line feed will be added after
7320 the last header of an HTTP request.
7321
7322 Header transformations only apply to traffic which passes through HAProxy,
7323 and not to traffic generated by HAProxy, such as health-checks or error
7324 responses.
7325
Willy Tarreau8abd4cd2010-01-31 14:30:44 +01007326 Example : add "X-Proto: SSL" to requests coming via port 81
7327 acl is-ssl dst_port 81
7328 reqadd X-Proto:\ SSL if is-ssl
7329
Ruoshan Huangeb5a3632015-12-08 21:00:23 +08007330 See also: "rspadd", "http-request", section 6 about HTTP header manipulation,
7331 and section 7 about ACLs.
Willy Tarreau303c0352008-01-17 19:01:39 +01007332
7333
Willy Tarreau5321c422010-01-28 20:35:13 +01007334reqallow <search> [{if | unless} <cond>]
7335reqiallow <search> [{if | unless} <cond>] (ignore case)
Willy Tarreau303c0352008-01-17 19:01:39 +01007336 Definitely allow an HTTP request if a line matches a regular expression
7337 May be used in sections : defaults | frontend | listen | backend
7338 no | yes | yes | yes
7339 Arguments :
7340 <search> is the regular expression applied to HTTP headers and to the
7341 request line. This is an extended regular expression. Parenthesis
7342 grouping is supported and no preliminary backslash is required.
7343 Any space or known delimiter must be escaped using a backslash
7344 ('\'). The pattern applies to a full line at a time. The
7345 "reqallow" keyword strictly matches case while "reqiallow"
7346 ignores case.
7347
Willy Tarreau5321c422010-01-28 20:35:13 +01007348 <cond> is an optional matching condition built from ACLs. It makes it
7349 possible to ignore this rule when other conditions are not met.
7350
Willy Tarreau303c0352008-01-17 19:01:39 +01007351 A request containing any line which matches extended regular expression
7352 <search> will mark the request as allowed, even if any later test would
7353 result in a deny. The test applies both to the request line and to request
7354 headers. Keep in mind that URLs in request line are case-sensitive while
Willy Tarreaud72758d2010-01-12 10:42:19 +01007355 header names are not.
Willy Tarreau303c0352008-01-17 19:01:39 +01007356
7357 It is easier, faster and more powerful to use ACLs to write access policies.
7358 Reqdeny, reqallow and reqpass should be avoided in new designs.
7359
7360 Example :
7361 # allow www.* but refuse *.local
7362 reqiallow ^Host:\ www\.
7363 reqideny ^Host:\ .*\.local
7364
Ruoshan Huangeb5a3632015-12-08 21:00:23 +08007365 See also: "reqdeny", "block", "http-request", section 6 about HTTP header
7366 manipulation, and section 7 about ACLs.
Willy Tarreau303c0352008-01-17 19:01:39 +01007367
7368
Willy Tarreau5321c422010-01-28 20:35:13 +01007369reqdel <search> [{if | unless} <cond>]
7370reqidel <search> [{if | unless} <cond>] (ignore case)
Willy Tarreau303c0352008-01-17 19:01:39 +01007371 Delete all headers matching a regular expression in an HTTP request
7372 May be used in sections : defaults | frontend | listen | backend
7373 no | yes | yes | yes
7374 Arguments :
7375 <search> is the regular expression applied to HTTP headers and to the
7376 request line. This is an extended regular expression. Parenthesis
7377 grouping is supported and no preliminary backslash is required.
7378 Any space or known delimiter must be escaped using a backslash
7379 ('\'). The pattern applies to a full line at a time. The "reqdel"
7380 keyword strictly matches case while "reqidel" ignores case.
7381
Willy Tarreau5321c422010-01-28 20:35:13 +01007382 <cond> is an optional matching condition built from ACLs. It makes it
7383 possible to ignore this rule when other conditions are not met.
7384
Willy Tarreau303c0352008-01-17 19:01:39 +01007385 Any header line matching extended regular expression <search> in the request
7386 will be completely deleted. Most common use of this is to remove unwanted
7387 and/or dangerous headers or cookies from a request before passing it to the
7388 next servers.
7389
7390 Header transformations only apply to traffic which passes through HAProxy,
7391 and not to traffic generated by HAProxy, such as health-checks or error
7392 responses. Keep in mind that header names are not case-sensitive.
7393
7394 Example :
7395 # remove X-Forwarded-For header and SERVER cookie
7396 reqidel ^X-Forwarded-For:.*
7397 reqidel ^Cookie:.*SERVER=
7398
Ruoshan Huangeb5a3632015-12-08 21:00:23 +08007399 See also: "reqadd", "reqrep", "rspdel", "http-request", section 6 about
7400 HTTP header manipulation, and section 7 about ACLs.
Willy Tarreau303c0352008-01-17 19:01:39 +01007401
7402
Willy Tarreau5321c422010-01-28 20:35:13 +01007403reqdeny <search> [{if | unless} <cond>]
7404reqideny <search> [{if | unless} <cond>] (ignore case)
Willy Tarreau303c0352008-01-17 19:01:39 +01007405 Deny an HTTP request if a line matches a regular expression
7406 May be used in sections : defaults | frontend | listen | backend
7407 no | yes | yes | yes
7408 Arguments :
7409 <search> is the regular expression applied to HTTP headers and to the
7410 request line. This is an extended regular expression. Parenthesis
7411 grouping is supported and no preliminary backslash is required.
7412 Any space or known delimiter must be escaped using a backslash
7413 ('\'). The pattern applies to a full line at a time. The
7414 "reqdeny" keyword strictly matches case while "reqideny" ignores
7415 case.
7416
Willy Tarreau5321c422010-01-28 20:35:13 +01007417 <cond> is an optional matching condition built from ACLs. It makes it
7418 possible to ignore this rule when other conditions are not met.
7419
Willy Tarreau303c0352008-01-17 19:01:39 +01007420 A request containing any line which matches extended regular expression
7421 <search> will mark the request as denied, even if any later test would
7422 result in an allow. The test applies both to the request line and to request
7423 headers. Keep in mind that URLs in request line are case-sensitive while
Willy Tarreaud72758d2010-01-12 10:42:19 +01007424 header names are not.
Willy Tarreau303c0352008-01-17 19:01:39 +01007425
Willy Tarreauced27012008-01-17 20:35:34 +01007426 A denied request will generate an "HTTP 403 forbidden" response once the
Willy Tarreaud2a4aa22008-01-31 15:28:22 +01007427 complete request has been parsed. This is consistent with what is practiced
Willy Tarreaud72758d2010-01-12 10:42:19 +01007428 using ACLs.
Willy Tarreauced27012008-01-17 20:35:34 +01007429
Willy Tarreau303c0352008-01-17 19:01:39 +01007430 It is easier, faster and more powerful to use ACLs to write access policies.
7431 Reqdeny, reqallow and reqpass should be avoided in new designs.
7432
7433 Example :
7434 # refuse *.local, then allow www.*
7435 reqideny ^Host:\ .*\.local
7436 reqiallow ^Host:\ www\.
7437
Ruoshan Huangeb5a3632015-12-08 21:00:23 +08007438 See also: "reqallow", "rspdeny", "block", "http-request", section 6 about
7439 HTTP header manipulation, and section 7 about ACLs.
Willy Tarreau303c0352008-01-17 19:01:39 +01007440
7441
Willy Tarreau5321c422010-01-28 20:35:13 +01007442reqpass <search> [{if | unless} <cond>]
7443reqipass <search> [{if | unless} <cond>] (ignore case)
Willy Tarreau303c0352008-01-17 19:01:39 +01007444 Ignore any HTTP request line matching a regular expression in next rules
7445 May be used in sections : defaults | frontend | listen | backend
7446 no | yes | yes | yes
7447 Arguments :
7448 <search> is the regular expression applied to HTTP headers and to the
7449 request line. This is an extended regular expression. Parenthesis
7450 grouping is supported and no preliminary backslash is required.
7451 Any space or known delimiter must be escaped using a backslash
7452 ('\'). The pattern applies to a full line at a time. The
7453 "reqpass" keyword strictly matches case while "reqipass" ignores
7454 case.
7455
Willy Tarreau5321c422010-01-28 20:35:13 +01007456 <cond> is an optional matching condition built from ACLs. It makes it
7457 possible to ignore this rule when other conditions are not met.
7458
Willy Tarreau303c0352008-01-17 19:01:39 +01007459 A request containing any line which matches extended regular expression
7460 <search> will skip next rules, without assigning any deny or allow verdict.
7461 The test applies both to the request line and to request headers. Keep in
7462 mind that URLs in request line are case-sensitive while header names are not.
7463
7464 It is easier, faster and more powerful to use ACLs to write access policies.
7465 Reqdeny, reqallow and reqpass should be avoided in new designs.
7466
7467 Example :
7468 # refuse *.local, then allow www.*, but ignore "www.private.local"
7469 reqipass ^Host:\ www.private\.local
7470 reqideny ^Host:\ .*\.local
7471 reqiallow ^Host:\ www\.
7472
Ruoshan Huangeb5a3632015-12-08 21:00:23 +08007473 See also: "reqallow", "reqdeny", "block", "http-request", section 6 about
7474 HTTP header manipulation, and section 7 about ACLs.
Willy Tarreau303c0352008-01-17 19:01:39 +01007475
7476
Willy Tarreau5321c422010-01-28 20:35:13 +01007477reqrep <search> <string> [{if | unless} <cond>]
7478reqirep <search> <string> [{if | unless} <cond>] (ignore case)
Willy Tarreau303c0352008-01-17 19:01:39 +01007479 Replace a regular expression with a string in an HTTP request line
7480 May be used in sections : defaults | frontend | listen | backend
7481 no | yes | yes | yes
7482 Arguments :
7483 <search> is the regular expression applied to HTTP headers and to the
7484 request line. This is an extended regular expression. Parenthesis
7485 grouping is supported and no preliminary backslash is required.
7486 Any space or known delimiter must be escaped using a backslash
7487 ('\'). The pattern applies to a full line at a time. The "reqrep"
7488 keyword strictly matches case while "reqirep" ignores case.
7489
7490 <string> is the complete line to be added. Any space or known delimiter
7491 must be escaped using a backslash ('\'). References to matched
7492 pattern groups are possible using the common \N form, with N
7493 being a single digit between 0 and 9. Please refer to section
Willy Tarreauc57f0e22009-05-10 13:12:33 +02007494 6 about HTTP header manipulation for more information.
Willy Tarreau303c0352008-01-17 19:01:39 +01007495
Willy Tarreau5321c422010-01-28 20:35:13 +01007496 <cond> is an optional matching condition built from ACLs. It makes it
7497 possible to ignore this rule when other conditions are not met.
7498
Willy Tarreau303c0352008-01-17 19:01:39 +01007499 Any line matching extended regular expression <search> in the request (both
7500 the request line and header lines) will be completely replaced with <string>.
7501 Most common use of this is to rewrite URLs or domain names in "Host" headers.
7502
7503 Header transformations only apply to traffic which passes through HAProxy,
7504 and not to traffic generated by HAProxy, such as health-checks or error
7505 responses. Note that for increased readability, it is suggested to add enough
7506 spaces between the request and the response. Keep in mind that URLs in
7507 request line are case-sensitive while header names are not.
7508
7509 Example :
7510 # replace "/static/" with "/" at the beginning of any request path.
Dmitry Sivachenko7823de32012-05-16 14:00:26 +04007511 reqrep ^([^\ :]*)\ /static/(.*) \1\ /\2
Willy Tarreau303c0352008-01-17 19:01:39 +01007512 # replace "www.mydomain.com" with "www" in the host name.
7513 reqirep ^Host:\ www.mydomain.com Host:\ www
7514
Ruoshan Huangeb5a3632015-12-08 21:00:23 +08007515 See also: "reqadd", "reqdel", "rsprep", "tune.bufsize", "http-request",
7516 section 6 about HTTP header manipulation, and section 7 about ACLs.
Willy Tarreau303c0352008-01-17 19:01:39 +01007517
7518
Willy Tarreau5321c422010-01-28 20:35:13 +01007519reqtarpit <search> [{if | unless} <cond>]
7520reqitarpit <search> [{if | unless} <cond>] (ignore case)
Willy Tarreau303c0352008-01-17 19:01:39 +01007521 Tarpit an HTTP request containing a line matching a regular expression
7522 May be used in sections : defaults | frontend | listen | backend
7523 no | yes | yes | yes
7524 Arguments :
7525 <search> is the regular expression applied to HTTP headers and to the
7526 request line. This is an extended regular expression. Parenthesis
7527 grouping is supported and no preliminary backslash is required.
7528 Any space or known delimiter must be escaped using a backslash
7529 ('\'). The pattern applies to a full line at a time. The
7530 "reqtarpit" keyword strictly matches case while "reqitarpit"
7531 ignores case.
7532
Willy Tarreau5321c422010-01-28 20:35:13 +01007533 <cond> is an optional matching condition built from ACLs. It makes it
7534 possible to ignore this rule when other conditions are not met.
7535
Willy Tarreau303c0352008-01-17 19:01:39 +01007536 A request containing any line which matches extended regular expression
7537 <search> will be tarpitted, which means that it will connect to nowhere, will
Willy Tarreauced27012008-01-17 20:35:34 +01007538 be kept open for a pre-defined time, then will return an HTTP error 500 so
7539 that the attacker does not suspect it has been tarpitted. The status 500 will
7540 be reported in the logs, but the completion flags will indicate "PT". The
Willy Tarreau303c0352008-01-17 19:01:39 +01007541 delay is defined by "timeout tarpit", or "timeout connect" if the former is
7542 not set.
7543
7544 The goal of the tarpit is to slow down robots attacking servers with
7545 identifiable requests. Many robots limit their outgoing number of connections
7546 and stay connected waiting for a reply which can take several minutes to
7547 come. Depending on the environment and attack, it may be particularly
7548 efficient at reducing the load on the network and firewalls.
7549
Willy Tarreau5321c422010-01-28 20:35:13 +01007550 Examples :
Davor Ocelice9ed2812017-12-25 17:49:28 +01007551 # ignore user-agents reporting any flavor of "Mozilla" or "MSIE", but
Willy Tarreau303c0352008-01-17 19:01:39 +01007552 # block all others.
7553 reqipass ^User-Agent:\.*(Mozilla|MSIE)
7554 reqitarpit ^User-Agent:
7555
Willy Tarreau5321c422010-01-28 20:35:13 +01007556 # block bad guys
7557 acl badguys src 10.1.0.3 172.16.13.20/28
7558 reqitarpit . if badguys
7559
Ruoshan Huangeb5a3632015-12-08 21:00:23 +08007560 See also: "reqallow", "reqdeny", "reqpass", "http-request", section 6
7561 about HTTP header manipulation, and section 7 about ACLs.
Willy Tarreau303c0352008-01-17 19:01:39 +01007562
7563
Willy Tarreaue5c5ce92008-06-20 17:27:19 +02007564retries <value>
7565 Set the number of retries to perform on a server after a connection failure
7566 May be used in sections: defaults | frontend | listen | backend
7567 yes | no | yes | yes
7568 Arguments :
7569 <value> is the number of times a connection attempt should be retried on
7570 a server when a connection either is refused or times out. The
7571 default value is 3.
7572
7573 It is important to understand that this value applies to the number of
7574 connection attempts, not full requests. When a connection has effectively
7575 been established to a server, there will be no more retry.
7576
7577 In order to avoid immediate reconnections to a server which is restarting,
Joseph Lynch726ab712015-05-11 23:25:34 -07007578 a turn-around timer of min("timeout connect", one second) is applied before
7579 a retry occurs.
Willy Tarreaue5c5ce92008-06-20 17:27:19 +02007580
7581 When "option redispatch" is set, the last retry may be performed on another
7582 server even if a cookie references a different server.
7583
7584 See also : "option redispatch"
7585
7586
Willy Tarreaufdb563c2010-01-31 15:43:27 +01007587rspadd <string> [{if | unless} <cond>]
Willy Tarreau303c0352008-01-17 19:01:39 +01007588 Add a header at the end of the HTTP response
7589 May be used in sections : defaults | frontend | listen | backend
7590 no | yes | yes | yes
7591 Arguments :
7592 <string> is the complete line to be added. Any space or known delimiter
7593 must be escaped using a backslash ('\'). Please refer to section
Willy Tarreauc57f0e22009-05-10 13:12:33 +02007594 6 about HTTP header manipulation for more information.
Willy Tarreau303c0352008-01-17 19:01:39 +01007595
Willy Tarreaufdb563c2010-01-31 15:43:27 +01007596 <cond> is an optional matching condition built from ACLs. It makes it
7597 possible to ignore this rule when other conditions are not met.
7598
Willy Tarreau303c0352008-01-17 19:01:39 +01007599 A new line consisting in <string> followed by a line feed will be added after
7600 the last header of an HTTP response.
7601
7602 Header transformations only apply to traffic which passes through HAProxy,
7603 and not to traffic generated by HAProxy, such as health-checks or error
7604 responses.
7605
Ruoshan Huangeb5a3632015-12-08 21:00:23 +08007606 See also: "rspdel" "reqadd", "http-response", section 6 about HTTP header
7607 manipulation, and section 7 about ACLs.
Willy Tarreau303c0352008-01-17 19:01:39 +01007608
7609
Willy Tarreaufdb563c2010-01-31 15:43:27 +01007610rspdel <search> [{if | unless} <cond>]
7611rspidel <search> [{if | unless} <cond>] (ignore case)
Willy Tarreau303c0352008-01-17 19:01:39 +01007612 Delete all headers matching a regular expression in an HTTP response
7613 May be used in sections : defaults | frontend | listen | backend
7614 no | yes | yes | yes
7615 Arguments :
7616 <search> is the regular expression applied to HTTP headers and to the
7617 response line. This is an extended regular expression, so
7618 parenthesis grouping is supported and no preliminary backslash
7619 is required. Any space or known delimiter must be escaped using
7620 a backslash ('\'). The pattern applies to a full line at a time.
7621 The "rspdel" keyword strictly matches case while "rspidel"
7622 ignores case.
7623
Willy Tarreaufdb563c2010-01-31 15:43:27 +01007624 <cond> is an optional matching condition built from ACLs. It makes it
7625 possible to ignore this rule when other conditions are not met.
7626
Willy Tarreau303c0352008-01-17 19:01:39 +01007627 Any header line matching extended regular expression <search> in the response
7628 will be completely deleted. Most common use of this is to remove unwanted
Willy Tarreau3c92c5f2011-08-28 09:45:47 +02007629 and/or sensitive headers or cookies from a response before passing it to the
Willy Tarreau303c0352008-01-17 19:01:39 +01007630 client.
7631
7632 Header transformations only apply to traffic which passes through HAProxy,
7633 and not to traffic generated by HAProxy, such as health-checks or error
7634 responses. Keep in mind that header names are not case-sensitive.
7635
7636 Example :
7637 # remove the Server header from responses
Willy Tarreau5e80e022013-05-25 08:31:25 +02007638 rspidel ^Server:.*
Willy Tarreau303c0352008-01-17 19:01:39 +01007639
Ruoshan Huangeb5a3632015-12-08 21:00:23 +08007640 See also: "rspadd", "rsprep", "reqdel", "http-response", section 6 about
7641 HTTP header manipulation, and section 7 about ACLs.
Willy Tarreau303c0352008-01-17 19:01:39 +01007642
7643
Willy Tarreaufdb563c2010-01-31 15:43:27 +01007644rspdeny <search> [{if | unless} <cond>]
7645rspideny <search> [{if | unless} <cond>] (ignore case)
Willy Tarreau303c0352008-01-17 19:01:39 +01007646 Block an HTTP response if a line matches a regular expression
7647 May be used in sections : defaults | frontend | listen | backend
7648 no | yes | yes | yes
7649 Arguments :
7650 <search> is the regular expression applied to HTTP headers and to the
7651 response line. This is an extended regular expression, so
7652 parenthesis grouping is supported and no preliminary backslash
7653 is required. Any space or known delimiter must be escaped using
7654 a backslash ('\'). The pattern applies to a full line at a time.
7655 The "rspdeny" keyword strictly matches case while "rspideny"
7656 ignores case.
7657
Willy Tarreaufdb563c2010-01-31 15:43:27 +01007658 <cond> is an optional matching condition built from ACLs. It makes it
7659 possible to ignore this rule when other conditions are not met.
7660
Willy Tarreau303c0352008-01-17 19:01:39 +01007661 A response containing any line which matches extended regular expression
7662 <search> will mark the request as denied. The test applies both to the
7663 response line and to response headers. Keep in mind that header names are not
7664 case-sensitive.
7665
7666 Main use of this keyword is to prevent sensitive information leak and to
Willy Tarreauced27012008-01-17 20:35:34 +01007667 block the response before it reaches the client. If a response is denied, it
7668 will be replaced with an HTTP 502 error so that the client never retrieves
7669 any sensitive data.
Willy Tarreau303c0352008-01-17 19:01:39 +01007670
7671 It is easier, faster and more powerful to use ACLs to write access policies.
7672 Rspdeny should be avoided in new designs.
7673
7674 Example :
7675 # Ensure that no content type matching ms-word will leak
7676 rspideny ^Content-type:\.*/ms-word
7677
Ruoshan Huangeb5a3632015-12-08 21:00:23 +08007678 See also: "reqdeny", "acl", "block", "http-response", section 6 about
7679 HTTP header manipulation and section 7 about ACLs.
Willy Tarreau303c0352008-01-17 19:01:39 +01007680
7681
Willy Tarreaufdb563c2010-01-31 15:43:27 +01007682rsprep <search> <string> [{if | unless} <cond>]
7683rspirep <search> <string> [{if | unless} <cond>] (ignore case)
Willy Tarreau303c0352008-01-17 19:01:39 +01007684 Replace a regular expression with a string in an HTTP response line
7685 May be used in sections : defaults | frontend | listen | backend
7686 no | yes | yes | yes
7687 Arguments :
7688 <search> is the regular expression applied to HTTP headers and to the
7689 response line. This is an extended regular expression, so
7690 parenthesis grouping is supported and no preliminary backslash
7691 is required. Any space or known delimiter must be escaped using
7692 a backslash ('\'). The pattern applies to a full line at a time.
7693 The "rsprep" keyword strictly matches case while "rspirep"
7694 ignores case.
7695
7696 <string> is the complete line to be added. Any space or known delimiter
7697 must be escaped using a backslash ('\'). References to matched
7698 pattern groups are possible using the common \N form, with N
7699 being a single digit between 0 and 9. Please refer to section
Willy Tarreauc57f0e22009-05-10 13:12:33 +02007700 6 about HTTP header manipulation for more information.
Willy Tarreau303c0352008-01-17 19:01:39 +01007701
Willy Tarreaufdb563c2010-01-31 15:43:27 +01007702 <cond> is an optional matching condition built from ACLs. It makes it
7703 possible to ignore this rule when other conditions are not met.
7704
Willy Tarreau303c0352008-01-17 19:01:39 +01007705 Any line matching extended regular expression <search> in the response (both
7706 the response line and header lines) will be completely replaced with
7707 <string>. Most common use of this is to rewrite Location headers.
7708
7709 Header transformations only apply to traffic which passes through HAProxy,
7710 and not to traffic generated by HAProxy, such as health-checks or error
7711 responses. Note that for increased readability, it is suggested to add enough
7712 spaces between the request and the response. Keep in mind that header names
7713 are not case-sensitive.
7714
7715 Example :
7716 # replace "Location: 127.0.0.1:8080" with "Location: www.mydomain.com"
7717 rspirep ^Location:\ 127.0.0.1:8080 Location:\ www.mydomain.com
7718
Ruoshan Huangeb5a3632015-12-08 21:00:23 +08007719 See also: "rspadd", "rspdel", "reqrep", "http-response", section 6 about
7720 HTTP header manipulation, and section 7 about ACLs.
Willy Tarreau303c0352008-01-17 19:01:39 +01007721
7722
David du Colombier486df472011-03-17 10:40:26 +01007723server <name> <address>[:[port]] [param*]
Willy Tarreaueabeafa2008-01-16 16:17:06 +01007724 Declare a server in a backend
7725 May be used in sections : defaults | frontend | listen | backend
7726 no | no | yes | yes
7727 Arguments :
7728 <name> is the internal name assigned to this server. This name will
Davor Ocelice9ed2812017-12-25 17:49:28 +01007729 appear in logs and alerts. If "http-send-name-header" is
Mark Lamourinec2247f02012-01-04 13:02:01 -05007730 set, it will be added to the request header sent to the server.
Willy Tarreaueabeafa2008-01-16 16:17:06 +01007731
David du Colombier486df472011-03-17 10:40:26 +01007732 <address> is the IPv4 or IPv6 address of the server. Alternatively, a
7733 resolvable hostname is supported, but this name will be resolved
7734 during start-up. Address "0.0.0.0" or "*" has a special meaning.
7735 It indicates that the connection will be forwarded to the same IP
Willy Tarreaud669a4f2010-07-13 14:49:50 +02007736 address as the one from the client connection. This is useful in
7737 transparent proxy architectures where the client's connection is
7738 intercepted and haproxy must forward to the original destination
7739 address. This is more or less what the "transparent" keyword does
7740 except that with a server it's possible to limit concurrency and
Willy Tarreau24709282013-03-10 21:32:12 +01007741 to report statistics. Optionally, an address family prefix may be
7742 used before the address to force the family regardless of the
7743 address format, which can be useful to specify a path to a unix
7744 socket with no slash ('/'). Currently supported prefixes are :
7745 - 'ipv4@' -> address is always IPv4
7746 - 'ipv6@' -> address is always IPv6
7747 - 'unix@' -> address is a path to a local unix socket
Willy Tarreauccfccef2014-05-10 01:49:15 +02007748 - 'abns@' -> address is in abstract namespace (Linux only)
William Lallemandb2f07452015-05-12 14:27:13 +02007749 You may want to reference some environment variables in the
7750 address parameter, see section 2.3 about environment
Willy Tarreau6a031d12016-11-07 19:42:35 +01007751 variables. The "init-addr" setting can be used to modify the way
7752 IP addresses should be resolved upon startup.
Willy Tarreaueabeafa2008-01-16 16:17:06 +01007753
Willy Tarreaub6205fd2012-09-24 12:27:33 +02007754 <port> is an optional port specification. If set, all connections will
Willy Tarreaueabeafa2008-01-16 16:17:06 +01007755 be sent to this port. If unset, the same port the client
7756 connected to will be used. The port may also be prefixed by a "+"
7757 or a "-". In this case, the server's port will be determined by
7758 adding this value to the client's port.
7759
7760 <param*> is a list of parameters for this server. The "server" keywords
7761 accepts an important number of options and has a complete section
Willy Tarreauc57f0e22009-05-10 13:12:33 +02007762 dedicated to it. Please refer to section 5 for more details.
Willy Tarreaueabeafa2008-01-16 16:17:06 +01007763
7764 Examples :
7765 server first 10.1.1.1:1080 cookie first check inter 1000
7766 server second 10.1.1.2:1080 cookie second check inter 1000
Willy Tarreau24709282013-03-10 21:32:12 +01007767 server transp ipv4@
William Lallemandb2f07452015-05-12 14:27:13 +02007768 server backup "${SRV_BACKUP}:1080" backup
7769 server www1_dc1 "${LAN_DC1}.101:80"
7770 server www1_dc2 "${LAN_DC2}.101:80"
Willy Tarreaueabeafa2008-01-16 16:17:06 +01007771
Willy Tarreau55dcaf62015-09-27 15:03:15 +02007772 Note: regarding Linux's abstract namespace sockets, HAProxy uses the whole
7773 sun_path length is used for the address length. Some other programs
7774 such as socat use the string length only by default. Pass the option
7775 ",unix-tightsocklen=0" to any abstract socket definition in socat to
7776 make it compatible with HAProxy's.
7777
Mark Lamourinec2247f02012-01-04 13:02:01 -05007778 See also: "default-server", "http-send-name-header" and section 5 about
7779 server options
Willy Tarreaueabeafa2008-01-16 16:17:06 +01007780
Baptiste Assmann01c6cc32015-08-23 11:45:29 +02007781server-state-file-name [<file>]
7782 Set the server state file to read, load and apply to servers available in
7783 this backend. It only applies when the directive "load-server-state-from-file"
7784 is set to "local". When <file> is not provided or if this directive is not
7785 set, then backend name is used. If <file> starts with a slash '/', then it is
7786 considered as an absolute path. Otherwise, <file> is concatenated to the
7787 global directive "server-state-file-base".
7788
7789 Example: the minimal configuration below would make HAProxy look for the
7790 state server file '/etc/haproxy/states/bk':
7791
7792 global
7793 server-state-file-base /etc/haproxy/states
7794
7795 backend bk
7796 load-server-state-from-file
7797
7798 See also: "server-state-file-base", "load-server-state-from-file", and
7799 "show servers state"
Willy Tarreaueabeafa2008-01-16 16:17:06 +01007800
Frédéric Lécaillecb4502e2017-04-20 13:36:25 +02007801server-template <prefix> <num | range> <fqdn>[:<port>] [params*]
7802 Set a template to initialize servers with shared parameters.
7803 The names of these servers are built from <prefix> and <num | range> parameters.
7804 May be used in sections : defaults | frontend | listen | backend
7805 no | no | yes | yes
7806
7807 Arguments:
7808 <prefix> A prefix for the server names to be built.
7809
7810 <num | range>
7811 If <num> is provided, this template initializes <num> servers
7812 with 1 up to <num> as server name suffixes. A range of numbers
7813 <num_low>-<num_high> may also be used to use <num_low> up to
7814 <num_high> as server name suffixes.
7815
7816 <fqdn> A FQDN for all the servers this template initializes.
7817
7818 <port> Same meaning as "server" <port> argument (see "server" keyword).
7819
7820 <params*>
7821 Remaining server parameters among all those supported by "server"
7822 keyword.
7823
7824 Examples:
7825 # Initializes 3 servers with srv1, srv2 and srv3 as names,
7826 # google.com as FQDN, and health-check enabled.
7827 server-template srv 1-3 google.com:80 check
7828
7829 # or
7830 server-template srv 3 google.com:80 check
7831
7832 # would be equivalent to:
7833 server srv1 google.com:80 check
7834 server srv2 google.com:80 check
7835 server srv3 google.com:80 check
7836
7837
7838
Willy Tarreaueabeafa2008-01-16 16:17:06 +01007839source <addr>[:<port>] [usesrc { <addr2>[:<port2>] | client | clientip } ]
Willy Tarreaubce70882009-09-07 11:51:47 +02007840source <addr>[:<port>] [usesrc { <addr2>[:<port2>] | hdr_ip(<hdr>[,<occ>]) } ]
Willy Tarreaud53f96b2009-02-04 18:46:54 +01007841source <addr>[:<port>] [interface <name>]
Willy Tarreaueabeafa2008-01-16 16:17:06 +01007842 Set the source address for outgoing connections
7843 May be used in sections : defaults | frontend | listen | backend
7844 yes | no | yes | yes
7845 Arguments :
7846 <addr> is the IPv4 address HAProxy will bind to before connecting to a
7847 server. This address is also used as a source for health checks.
Willy Tarreau24709282013-03-10 21:32:12 +01007848
Willy Tarreaueabeafa2008-01-16 16:17:06 +01007849 The default value of 0.0.0.0 means that the system will select
Willy Tarreau24709282013-03-10 21:32:12 +01007850 the most appropriate address to reach its destination. Optionally
7851 an address family prefix may be used before the address to force
7852 the family regardless of the address format, which can be useful
7853 to specify a path to a unix socket with no slash ('/'). Currently
7854 supported prefixes are :
7855 - 'ipv4@' -> address is always IPv4
7856 - 'ipv6@' -> address is always IPv6
7857 - 'unix@' -> address is a path to a local unix socket
Willy Tarreauccfccef2014-05-10 01:49:15 +02007858 - 'abns@' -> address is in abstract namespace (Linux only)
Cyril Bonté307ee1e2015-09-28 23:16:06 +02007859 You may want to reference some environment variables in the
7860 address parameter, see section 2.3 about environment variables.
Willy Tarreaueabeafa2008-01-16 16:17:06 +01007861
7862 <port> is an optional port. It is normally not needed but may be useful
7863 in some very specific contexts. The default value of zero means
Willy Tarreauc6f4ce82009-06-10 11:09:37 +02007864 the system will select a free port. Note that port ranges are not
7865 supported in the backend. If you want to force port ranges, you
7866 have to specify them on each "server" line.
Willy Tarreaueabeafa2008-01-16 16:17:06 +01007867
7868 <addr2> is the IP address to present to the server when connections are
7869 forwarded in full transparent proxy mode. This is currently only
7870 supported on some patched Linux kernels. When this address is
7871 specified, clients connecting to the server will be presented
7872 with this address, while health checks will still use the address
7873 <addr>.
7874
7875 <port2> is the optional port to present to the server when connections
7876 are forwarded in full transparent proxy mode (see <addr2> above).
7877 The default value of zero means the system will select a free
7878 port.
7879
Willy Tarreaubce70882009-09-07 11:51:47 +02007880 <hdr> is the name of a HTTP header in which to fetch the IP to bind to.
7881 This is the name of a comma-separated header list which can
7882 contain multiple IP addresses. By default, the last occurrence is
7883 used. This is designed to work with the X-Forwarded-For header
Baptiste Assmannea3e73b2013-02-02 23:47:49 +01007884 and to automatically bind to the client's IP address as seen
Willy Tarreaubce70882009-09-07 11:51:47 +02007885 by previous proxy, typically Stunnel. In order to use another
7886 occurrence from the last one, please see the <occ> parameter
7887 below. When the header (or occurrence) is not found, no binding
7888 is performed so that the proxy's default IP address is used. Also
7889 keep in mind that the header name is case insensitive, as for any
7890 HTTP header.
7891
7892 <occ> is the occurrence number of a value to be used in a multi-value
7893 header. This is to be used in conjunction with "hdr_ip(<hdr>)",
Jamie Gloudonaaa21002012-08-25 00:18:33 -04007894 in order to specify which occurrence to use for the source IP
Willy Tarreaubce70882009-09-07 11:51:47 +02007895 address. Positive values indicate a position from the first
7896 occurrence, 1 being the first one. Negative values indicate
7897 positions relative to the last one, -1 being the last one. This
7898 is helpful for situations where an X-Forwarded-For header is set
7899 at the entry point of an infrastructure and must be used several
7900 proxy layers away. When this value is not specified, -1 is
7901 assumed. Passing a zero here disables the feature.
7902
Willy Tarreaud53f96b2009-02-04 18:46:54 +01007903 <name> is an optional interface name to which to bind to for outgoing
7904 traffic. On systems supporting this features (currently, only
7905 Linux), this allows one to bind all traffic to the server to
7906 this interface even if it is not the one the system would select
7907 based on routing tables. This should be used with extreme care.
7908 Note that using this option requires root privileges.
7909
Willy Tarreaueabeafa2008-01-16 16:17:06 +01007910 The "source" keyword is useful in complex environments where a specific
7911 address only is allowed to connect to the servers. It may be needed when a
7912 private address must be used through a public gateway for instance, and it is
7913 known that the system cannot determine the adequate source address by itself.
7914
7915 An extension which is available on certain patched Linux kernels may be used
7916 through the "usesrc" optional keyword. It makes it possible to connect to the
7917 servers with an IP address which does not belong to the system itself. This
7918 is called "full transparent proxy mode". For this to work, the destination
7919 servers have to route their traffic back to this address through the machine
7920 running HAProxy, and IP forwarding must generally be enabled on this machine.
7921
7922 In this "full transparent proxy" mode, it is possible to force a specific IP
7923 address to be presented to the servers. This is not much used in fact. A more
7924 common use is to tell HAProxy to present the client's IP address. For this,
7925 there are two methods :
7926
7927 - present the client's IP and port addresses. This is the most transparent
7928 mode, but it can cause problems when IP connection tracking is enabled on
7929 the machine, because a same connection may be seen twice with different
7930 states. However, this solution presents the huge advantage of not
7931 limiting the system to the 64k outgoing address+port couples, because all
7932 of the client ranges may be used.
7933
7934 - present only the client's IP address and select a spare port. This
7935 solution is still quite elegant but slightly less transparent (downstream
7936 firewalls logs will not match upstream's). It also presents the downside
7937 of limiting the number of concurrent connections to the usual 64k ports.
7938 However, since the upstream and downstream ports are different, local IP
7939 connection tracking on the machine will not be upset by the reuse of the
7940 same session.
7941
Willy Tarreaueabeafa2008-01-16 16:17:06 +01007942 This option sets the default source for all servers in the backend. It may
7943 also be specified in a "defaults" section. Finer source address specification
7944 is possible at the server level using the "source" server option. Refer to
Willy Tarreauc57f0e22009-05-10 13:12:33 +02007945 section 5 for more information.
Willy Tarreaueabeafa2008-01-16 16:17:06 +01007946
Baptiste Assmann91bd3372015-07-17 21:59:42 +02007947 In order to work, "usesrc" requires root privileges.
7948
Willy Tarreaueabeafa2008-01-16 16:17:06 +01007949 Examples :
7950 backend private
7951 # Connect to the servers using our 192.168.1.200 source address
7952 source 192.168.1.200
7953
7954 backend transparent_ssl1
7955 # Connect to the SSL farm from the client's source address
7956 source 192.168.1.200 usesrc clientip
7957
7958 backend transparent_ssl2
7959 # Connect to the SSL farm from the client's source address and port
7960 # not recommended if IP conntrack is present on the local machine.
7961 source 192.168.1.200 usesrc client
7962
7963 backend transparent_ssl3
7964 # Connect to the SSL farm from the client's source address. It
7965 # is more conntrack-friendly.
7966 source 192.168.1.200 usesrc clientip
7967
7968 backend transparent_smtp
7969 # Connect to the SMTP farm from the client's source address/port
7970 # with Tproxy version 4.
7971 source 0.0.0.0 usesrc clientip
7972
Willy Tarreaubce70882009-09-07 11:51:47 +02007973 backend transparent_http
7974 # Connect to the servers using the client's IP as seen by previous
7975 # proxy.
7976 source 0.0.0.0 usesrc hdr_ip(x-forwarded-for,-1)
7977
Willy Tarreauc57f0e22009-05-10 13:12:33 +02007978 See also : the "source" server option in section 5, the Tproxy patches for
Willy Tarreaueabeafa2008-01-16 16:17:06 +01007979 the Linux kernel on www.balabit.com, the "bind" keyword.
7980
Krzysztof Piotr Oledzki25b501a2008-01-06 16:36:16 +01007981
Willy Tarreau844e3c52008-01-11 16:28:18 +01007982srvtimeout <timeout> (deprecated)
7983 Set the maximum inactivity time on the server side.
7984 May be used in sections : defaults | frontend | listen | backend
7985 yes | no | yes | yes
7986 Arguments :
7987 <timeout> is the timeout value specified in milliseconds by default, but
7988 can be in any other unit if the number is suffixed by the unit,
7989 as explained at the top of this document.
7990
7991 The inactivity timeout applies when the server is expected to acknowledge or
7992 send data. In HTTP mode, this timeout is particularly important to consider
7993 during the first phase of the server's response, when it has to send the
7994 headers, as it directly represents the server's processing time for the
7995 request. To find out what value to put there, it's often good to start with
7996 what would be considered as unacceptable response times, then check the logs
7997 to observe the response time distribution, and adjust the value accordingly.
7998
7999 The value is specified in milliseconds by default, but can be in any other
8000 unit if the number is suffixed by the unit, as specified at the top of this
8001 document. In TCP mode (and to a lesser extent, in HTTP mode), it is highly
8002 recommended that the client timeout remains equal to the server timeout in
8003 order to avoid complex situations to debug. Whatever the expected server
Willy Tarreaud2a4aa22008-01-31 15:28:22 +01008004 response times, it is a good practice to cover at least one or several TCP
Willy Tarreau844e3c52008-01-11 16:28:18 +01008005 packet losses by specifying timeouts that are slightly above multiples of 3
Davor Ocelice9ed2812017-12-25 17:49:28 +01008006 seconds (e.g. 4 or 5 seconds minimum).
Willy Tarreau844e3c52008-01-11 16:28:18 +01008007
8008 This parameter is specific to backends, but can be specified once for all in
8009 "defaults" sections. This is in fact one of the easiest solutions not to
8010 forget about it. An unspecified timeout results in an infinite timeout, which
8011 is not recommended. Such a usage is accepted and works but reports a warning
8012 during startup because it may results in accumulation of expired sessions in
8013 the system if the system's timeouts are not configured either.
8014
8015 This parameter is provided for compatibility but is currently deprecated.
8016 Please use "timeout server" instead.
8017
Willy Tarreauce887fd2012-05-12 12:50:00 +02008018 See also : "timeout server", "timeout tunnel", "timeout client" and
8019 "clitimeout".
Willy Tarreau844e3c52008-01-11 16:28:18 +01008020
8021
Cyril Bonté66c327d2010-10-12 00:14:37 +02008022stats admin { if | unless } <cond>
8023 Enable statistics admin level if/unless a condition is matched
8024 May be used in sections : defaults | frontend | listen | backend
Willy Tarreaued2119c2014-04-24 22:10:39 +02008025 no | yes | yes | yes
Cyril Bonté66c327d2010-10-12 00:14:37 +02008026
8027 This statement enables the statistics admin level if/unless a condition is
8028 matched.
8029
8030 The admin level allows to enable/disable servers from the web interface. By
8031 default, statistics page is read-only for security reasons.
8032
Cyril Bonté02ff8ef2010-12-14 22:48:49 +01008033 Note : Consider not using this feature in multi-process mode (nbproc > 1)
8034 unless you know what you do : memory is not shared between the
Davor Ocelice9ed2812017-12-25 17:49:28 +01008035 processes, which can result in random behaviors.
Cyril Bonté02ff8ef2010-12-14 22:48:49 +01008036
Cyril Bonté23b39d92011-02-10 22:54:44 +01008037 Currently, the POST request is limited to the buffer size minus the reserved
8038 buffer space, which means that if the list of servers is too long, the
8039 request won't be processed. It is recommended to alter few servers at a
8040 time.
Cyril Bonté66c327d2010-10-12 00:14:37 +02008041
8042 Example :
8043 # statistics admin level only for localhost
8044 backend stats_localhost
8045 stats enable
8046 stats admin if LOCALHOST
8047
8048 Example :
8049 # statistics admin level always enabled because of the authentication
8050 backend stats_auth
8051 stats enable
8052 stats auth admin:AdMiN123
8053 stats admin if TRUE
8054
8055 Example :
8056 # statistics admin level depends on the authenticated user
8057 userlist stats-auth
8058 group admin users admin
8059 user admin insecure-password AdMiN123
8060 group readonly users haproxy
8061 user haproxy insecure-password haproxy
8062
8063 backend stats_auth
8064 stats enable
8065 acl AUTH http_auth(stats-auth)
8066 acl AUTH_ADMIN http_auth_group(stats-auth) admin
8067 stats http-request auth unless AUTH
8068 stats admin if AUTH_ADMIN
8069
Cyril Bonté02ff8ef2010-12-14 22:48:49 +01008070 See also : "stats enable", "stats auth", "stats http-request", "nbproc",
8071 "bind-process", section 3.4 about userlists and section 7 about
8072 ACL usage.
Cyril Bonté66c327d2010-10-12 00:14:37 +02008073
8074
Willy Tarreaueabeafa2008-01-16 16:17:06 +01008075stats auth <user>:<passwd>
8076 Enable statistics with authentication and grant access to an account
8077 May be used in sections : defaults | frontend | listen | backend
Willy Tarreaued2119c2014-04-24 22:10:39 +02008078 yes | yes | yes | yes
Willy Tarreaueabeafa2008-01-16 16:17:06 +01008079 Arguments :
8080 <user> is a user name to grant access to
8081
8082 <passwd> is the cleartext password associated to this user
8083
8084 This statement enables statistics with default settings, and restricts access
8085 to declared users only. It may be repeated as many times as necessary to
8086 allow as many users as desired. When a user tries to access the statistics
8087 without a valid account, a "401 Forbidden" response will be returned so that
8088 the browser asks the user to provide a valid user and password. The real
8089 which will be returned to the browser is configurable using "stats realm".
8090
8091 Since the authentication method is HTTP Basic Authentication, the passwords
8092 circulate in cleartext on the network. Thus, it was decided that the
8093 configuration file would also use cleartext passwords to remind the users
Willy Tarreau3c92c5f2011-08-28 09:45:47 +02008094 that those ones should not be sensitive and not shared with any other account.
Willy Tarreaueabeafa2008-01-16 16:17:06 +01008095
8096 It is also possible to reduce the scope of the proxies which appear in the
8097 report using "stats scope".
8098
8099 Though this statement alone is enough to enable statistics reporting, it is
8100 recommended to set all other settings in order to avoid relying on default
8101 unobvious parameters.
8102
8103 Example :
8104 # public access (limited to this backend only)
8105 backend public_www
8106 server srv1 192.168.0.1:80
8107 stats enable
8108 stats hide-version
8109 stats scope .
8110 stats uri /admin?stats
Davor Ocelice9ed2812017-12-25 17:49:28 +01008111 stats realm HAProxy\ Statistics
Willy Tarreaueabeafa2008-01-16 16:17:06 +01008112 stats auth admin1:AdMiN123
8113 stats auth admin2:AdMiN321
8114
8115 # internal monitoring access (unlimited)
8116 backend private_monitoring
8117 stats enable
8118 stats uri /admin?stats
8119 stats refresh 5s
8120
8121 See also : "stats enable", "stats realm", "stats scope", "stats uri"
8122
8123
8124stats enable
8125 Enable statistics reporting with default settings
8126 May be used in sections : defaults | frontend | listen | backend
Willy Tarreaued2119c2014-04-24 22:10:39 +02008127 yes | yes | yes | yes
Willy Tarreaueabeafa2008-01-16 16:17:06 +01008128 Arguments : none
8129
8130 This statement enables statistics reporting with default settings defined
8131 at build time. Unless stated otherwise, these settings are used :
8132 - stats uri : /haproxy?stats
8133 - stats realm : "HAProxy Statistics"
8134 - stats auth : no authentication
8135 - stats scope : no restriction
8136
8137 Though this statement alone is enough to enable statistics reporting, it is
8138 recommended to set all other settings in order to avoid relying on default
8139 unobvious parameters.
8140
8141 Example :
8142 # public access (limited to this backend only)
8143 backend public_www
8144 server srv1 192.168.0.1:80
8145 stats enable
8146 stats hide-version
8147 stats scope .
8148 stats uri /admin?stats
Davor Ocelice9ed2812017-12-25 17:49:28 +01008149 stats realm HAProxy\ Statistics
Willy Tarreaueabeafa2008-01-16 16:17:06 +01008150 stats auth admin1:AdMiN123
8151 stats auth admin2:AdMiN321
8152
8153 # internal monitoring access (unlimited)
8154 backend private_monitoring
8155 stats enable
8156 stats uri /admin?stats
8157 stats refresh 5s
8158
8159 See also : "stats auth", "stats realm", "stats uri"
8160
8161
Willy Tarreaud63335a2010-02-26 12:56:52 +01008162stats hide-version
8163 Enable statistics and hide HAProxy version reporting
Willy Tarreau1d45b7c2009-08-16 10:29:18 +02008164 May be used in sections : defaults | frontend | listen | backend
Willy Tarreaued2119c2014-04-24 22:10:39 +02008165 yes | yes | yes | yes
Willy Tarreaud63335a2010-02-26 12:56:52 +01008166 Arguments : none
Willy Tarreau1d45b7c2009-08-16 10:29:18 +02008167
Willy Tarreaud63335a2010-02-26 12:56:52 +01008168 By default, the stats page reports some useful status information along with
8169 the statistics. Among them is HAProxy's version. However, it is generally
8170 considered dangerous to report precise version to anyone, as it can help them
8171 target known weaknesses with specific attacks. The "stats hide-version"
8172 statement removes the version from the statistics report. This is recommended
8173 for public sites or any site with a weak login/password.
Willy Tarreau1d45b7c2009-08-16 10:29:18 +02008174
Krzysztof Piotr Oledzki48cb2ae2009-10-02 22:51:14 +02008175 Though this statement alone is enough to enable statistics reporting, it is
8176 recommended to set all other settings in order to avoid relying on default
8177 unobvious parameters.
8178
Willy Tarreaud63335a2010-02-26 12:56:52 +01008179 Example :
8180 # public access (limited to this backend only)
8181 backend public_www
8182 server srv1 192.168.0.1:80
Krzysztof Piotr Oledzki48cb2ae2009-10-02 22:51:14 +02008183 stats enable
Willy Tarreaud63335a2010-02-26 12:56:52 +01008184 stats hide-version
8185 stats scope .
8186 stats uri /admin?stats
Davor Ocelice9ed2812017-12-25 17:49:28 +01008187 stats realm HAProxy\ Statistics
Willy Tarreaud63335a2010-02-26 12:56:52 +01008188 stats auth admin1:AdMiN123
8189 stats auth admin2:AdMiN321
Willy Tarreau1d45b7c2009-08-16 10:29:18 +02008190
Willy Tarreau1d45b7c2009-08-16 10:29:18 +02008191 # internal monitoring access (unlimited)
8192 backend private_monitoring
8193 stats enable
Willy Tarreaud63335a2010-02-26 12:56:52 +01008194 stats uri /admin?stats
8195 stats refresh 5s
Krzysztof Piotr Oledzki15514c22010-01-04 16:03:09 +01008196
Willy Tarreaud63335a2010-02-26 12:56:52 +01008197 See also : "stats auth", "stats enable", "stats realm", "stats uri"
Willy Tarreau1d45b7c2009-08-16 10:29:18 +02008198
Willy Tarreau983e01e2010-01-11 18:42:06 +01008199
Cyril Bonté2be1b3f2010-09-30 23:46:30 +02008200stats http-request { allow | deny | auth [realm <realm>] }
8201 [ { if | unless } <condition> ]
8202 Access control for statistics
8203
8204 May be used in sections: defaults | frontend | listen | backend
8205 no | no | yes | yes
8206
8207 As "http-request", these set of options allow to fine control access to
8208 statistics. Each option may be followed by if/unless and acl.
8209 First option with matched condition (or option without condition) is final.
8210 For "deny" a 403 error will be returned, for "allow" normal processing is
8211 performed, for "auth" a 401/407 error code is returned so the client
8212 should be asked to enter a username and password.
8213
8214 There is no fixed limit to the number of http-request statements per
8215 instance.
8216
8217 See also : "http-request", section 3.4 about userlists and section 7
8218 about ACL usage.
8219
8220
Willy Tarreaueabeafa2008-01-16 16:17:06 +01008221stats realm <realm>
8222 Enable statistics and set authentication realm
8223 May be used in sections : defaults | frontend | listen | backend
Willy Tarreaued2119c2014-04-24 22:10:39 +02008224 yes | yes | yes | yes
Willy Tarreaueabeafa2008-01-16 16:17:06 +01008225 Arguments :
8226 <realm> is the name of the HTTP Basic Authentication realm reported to
8227 the browser. The browser uses it to display it in the pop-up
8228 inviting the user to enter a valid username and password.
8229
8230 The realm is read as a single word, so any spaces in it should be escaped
8231 using a backslash ('\').
8232
8233 This statement is useful only in conjunction with "stats auth" since it is
8234 only related to authentication.
8235
8236 Though this statement alone is enough to enable statistics reporting, it is
8237 recommended to set all other settings in order to avoid relying on default
8238 unobvious parameters.
8239
8240 Example :
8241 # public access (limited to this backend only)
8242 backend public_www
8243 server srv1 192.168.0.1:80
8244 stats enable
8245 stats hide-version
8246 stats scope .
8247 stats uri /admin?stats
Davor Ocelice9ed2812017-12-25 17:49:28 +01008248 stats realm HAProxy\ Statistics
Willy Tarreaueabeafa2008-01-16 16:17:06 +01008249 stats auth admin1:AdMiN123
8250 stats auth admin2:AdMiN321
8251
8252 # internal monitoring access (unlimited)
8253 backend private_monitoring
8254 stats enable
8255 stats uri /admin?stats
8256 stats refresh 5s
8257
8258 See also : "stats auth", "stats enable", "stats uri"
8259
8260
8261stats refresh <delay>
8262 Enable statistics with automatic refresh
8263 May be used in sections : defaults | frontend | listen | backend
Willy Tarreaued2119c2014-04-24 22:10:39 +02008264 yes | yes | yes | yes
Willy Tarreaueabeafa2008-01-16 16:17:06 +01008265 Arguments :
8266 <delay> is the suggested refresh delay, specified in seconds, which will
8267 be returned to the browser consulting the report page. While the
8268 browser is free to apply any delay, it will generally respect it
8269 and refresh the page this every seconds. The refresh interval may
8270 be specified in any other non-default time unit, by suffixing the
8271 unit after the value, as explained at the top of this document.
8272
8273 This statement is useful on monitoring displays with a permanent page
8274 reporting the load balancer's activity. When set, the HTML report page will
8275 include a link "refresh"/"stop refresh" so that the user can select whether
8276 he wants automatic refresh of the page or not.
8277
8278 Though this statement alone is enough to enable statistics reporting, it is
8279 recommended to set all other settings in order to avoid relying on default
8280 unobvious parameters.
8281
8282 Example :
8283 # public access (limited to this backend only)
8284 backend public_www
8285 server srv1 192.168.0.1:80
8286 stats enable
8287 stats hide-version
8288 stats scope .
8289 stats uri /admin?stats
Davor Ocelice9ed2812017-12-25 17:49:28 +01008290 stats realm HAProxy\ Statistics
Willy Tarreaueabeafa2008-01-16 16:17:06 +01008291 stats auth admin1:AdMiN123
8292 stats auth admin2:AdMiN321
8293
8294 # internal monitoring access (unlimited)
8295 backend private_monitoring
8296 stats enable
8297 stats uri /admin?stats
8298 stats refresh 5s
8299
8300 See also : "stats auth", "stats enable", "stats realm", "stats uri"
8301
8302
8303stats scope { <name> | "." }
8304 Enable statistics and limit access scope
8305 May be used in sections : defaults | frontend | listen | backend
Willy Tarreaued2119c2014-04-24 22:10:39 +02008306 yes | yes | yes | yes
Willy Tarreaueabeafa2008-01-16 16:17:06 +01008307 Arguments :
8308 <name> is the name of a listen, frontend or backend section to be
8309 reported. The special name "." (a single dot) designates the
8310 section in which the statement appears.
8311
8312 When this statement is specified, only the sections enumerated with this
8313 statement will appear in the report. All other ones will be hidden. This
8314 statement may appear as many times as needed if multiple sections need to be
8315 reported. Please note that the name checking is performed as simple string
8316 comparisons, and that it is never checked that a give section name really
8317 exists.
8318
8319 Though this statement alone is enough to enable statistics reporting, it is
8320 recommended to set all other settings in order to avoid relying on default
8321 unobvious parameters.
8322
8323 Example :
8324 # public access (limited to this backend only)
8325 backend public_www
8326 server srv1 192.168.0.1:80
8327 stats enable
8328 stats hide-version
8329 stats scope .
8330 stats uri /admin?stats
Davor Ocelice9ed2812017-12-25 17:49:28 +01008331 stats realm HAProxy\ Statistics
Willy Tarreaueabeafa2008-01-16 16:17:06 +01008332 stats auth admin1:AdMiN123
8333 stats auth admin2:AdMiN321
8334
8335 # internal monitoring access (unlimited)
8336 backend private_monitoring
8337 stats enable
8338 stats uri /admin?stats
8339 stats refresh 5s
8340
8341 See also : "stats auth", "stats enable", "stats realm", "stats uri"
8342
Willy Tarreaud63335a2010-02-26 12:56:52 +01008343
Willy Tarreauc9705a12010-07-27 20:05:50 +02008344stats show-desc [ <desc> ]
Willy Tarreaud63335a2010-02-26 12:56:52 +01008345 Enable reporting of a description on the statistics page.
8346 May be used in sections : defaults | frontend | listen | backend
Willy Tarreaued2119c2014-04-24 22:10:39 +02008347 yes | yes | yes | yes
Willy Tarreaud63335a2010-02-26 12:56:52 +01008348
Willy Tarreauc9705a12010-07-27 20:05:50 +02008349 <desc> is an optional description to be reported. If unspecified, the
Willy Tarreaud63335a2010-02-26 12:56:52 +01008350 description from global section is automatically used instead.
8351
8352 This statement is useful for users that offer shared services to their
8353 customers, where node or description should be different for each customer.
8354
8355 Though this statement alone is enough to enable statistics reporting, it is
8356 recommended to set all other settings in order to avoid relying on default
Davor Ocelice9ed2812017-12-25 17:49:28 +01008357 unobvious parameters. By default description is not shown.
Willy Tarreaud63335a2010-02-26 12:56:52 +01008358
8359 Example :
8360 # internal monitoring access (unlimited)
8361 backend private_monitoring
8362 stats enable
8363 stats show-desc Master node for Europe, Asia, Africa
8364 stats uri /admin?stats
8365 stats refresh 5s
8366
8367 See also: "show-node", "stats enable", "stats uri" and "description" in
8368 global section.
8369
8370
8371stats show-legends
Willy Tarreaued2119c2014-04-24 22:10:39 +02008372 Enable reporting additional information on the statistics page
8373 May be used in sections : defaults | frontend | listen | backend
8374 yes | yes | yes | yes
8375 Arguments : none
8376
Jarno Huuskonen0e82b922014-04-12 18:22:19 +03008377 Enable reporting additional information on the statistics page :
Willy Tarreaud63335a2010-02-26 12:56:52 +01008378 - cap: capabilities (proxy)
8379 - mode: one of tcp, http or health (proxy)
8380 - id: SNMP ID (proxy, socket, server)
8381 - IP (socket, server)
8382 - cookie (backend, server)
8383
8384 Though this statement alone is enough to enable statistics reporting, it is
8385 recommended to set all other settings in order to avoid relying on default
Davor Ocelice9ed2812017-12-25 17:49:28 +01008386 unobvious parameters. Default behavior is not to show this information.
Willy Tarreaud63335a2010-02-26 12:56:52 +01008387
8388 See also: "stats enable", "stats uri".
8389
8390
8391stats show-node [ <name> ]
8392 Enable reporting of a host name on the statistics page.
8393 May be used in sections : defaults | frontend | listen | backend
Willy Tarreaued2119c2014-04-24 22:10:39 +02008394 yes | yes | yes | yes
Willy Tarreaud63335a2010-02-26 12:56:52 +01008395 Arguments:
8396 <name> is an optional name to be reported. If unspecified, the
8397 node name from global section is automatically used instead.
8398
8399 This statement is useful for users that offer shared services to their
8400 customers, where node or description might be different on a stats page
Davor Ocelice9ed2812017-12-25 17:49:28 +01008401 provided for each customer. Default behavior is not to show host name.
Willy Tarreaud63335a2010-02-26 12:56:52 +01008402
8403 Though this statement alone is enough to enable statistics reporting, it is
8404 recommended to set all other settings in order to avoid relying on default
8405 unobvious parameters.
8406
8407 Example:
8408 # internal monitoring access (unlimited)
8409 backend private_monitoring
8410 stats enable
8411 stats show-node Europe-1
8412 stats uri /admin?stats
8413 stats refresh 5s
8414
8415 See also: "show-desc", "stats enable", "stats uri", and "node" in global
8416 section.
8417
Willy Tarreaueabeafa2008-01-16 16:17:06 +01008418
8419stats uri <prefix>
8420 Enable statistics and define the URI prefix to access them
8421 May be used in sections : defaults | frontend | listen | backend
Willy Tarreaued2119c2014-04-24 22:10:39 +02008422 yes | yes | yes | yes
Willy Tarreaueabeafa2008-01-16 16:17:06 +01008423 Arguments :
8424 <prefix> is the prefix of any URI which will be redirected to stats. This
8425 prefix may contain a question mark ('?') to indicate part of a
8426 query string.
8427
8428 The statistics URI is intercepted on the relayed traffic, so it appears as a
8429 page within the normal application. It is strongly advised to ensure that the
8430 selected URI will never appear in the application, otherwise it will never be
8431 possible to reach it in the application.
8432
8433 The default URI compiled in haproxy is "/haproxy?stats", but this may be
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +01008434 changed at build time, so it's better to always explicitly specify it here.
Willy Tarreaueabeafa2008-01-16 16:17:06 +01008435 It is generally a good idea to include a question mark in the URI so that
8436 intermediate proxies refrain from caching the results. Also, since any string
8437 beginning with the prefix will be accepted as a stats request, the question
8438 mark helps ensuring that no valid URI will begin with the same words.
8439
8440 It is sometimes very convenient to use "/" as the URI prefix, and put that
8441 statement in a "listen" instance of its own. That makes it easy to dedicate
8442 an address or a port to statistics only.
8443
8444 Though this statement alone is enough to enable statistics reporting, it is
8445 recommended to set all other settings in order to avoid relying on default
8446 unobvious parameters.
8447
8448 Example :
8449 # public access (limited to this backend only)
8450 backend public_www
8451 server srv1 192.168.0.1:80
8452 stats enable
8453 stats hide-version
8454 stats scope .
8455 stats uri /admin?stats
Davor Ocelice9ed2812017-12-25 17:49:28 +01008456 stats realm HAProxy\ Statistics
Willy Tarreaueabeafa2008-01-16 16:17:06 +01008457 stats auth admin1:AdMiN123
8458 stats auth admin2:AdMiN321
8459
8460 # internal monitoring access (unlimited)
8461 backend private_monitoring
8462 stats enable
8463 stats uri /admin?stats
8464 stats refresh 5s
8465
8466 See also : "stats auth", "stats enable", "stats realm"
8467
8468
Willy Tarreaud63335a2010-02-26 12:56:52 +01008469stick match <pattern> [table <table>] [{if | unless} <cond>]
8470 Define a request pattern matching condition to stick a user to a server
Willy Tarreaueabeafa2008-01-16 16:17:06 +01008471 May be used in sections : defaults | frontend | listen | backend
Willy Tarreaud63335a2010-02-26 12:56:52 +01008472 no | no | yes | yes
Willy Tarreaub937b7e2010-01-12 15:27:54 +01008473
8474 Arguments :
Willy Tarreaube722a22014-06-13 16:31:59 +02008475 <pattern> is a sample expression rule as described in section 7.3. It
Willy Tarreaub937b7e2010-01-12 15:27:54 +01008476 describes what elements of the incoming request or connection
Davor Ocelice9ed2812017-12-25 17:49:28 +01008477 will be analyzed in the hope to find a matching entry in a
Willy Tarreaub937b7e2010-01-12 15:27:54 +01008478 stickiness table. This rule is mandatory.
8479
8480 <table> is an optional stickiness table name. If unspecified, the same
8481 backend's table is used. A stickiness table is declared using
8482 the "stick-table" statement.
8483
8484 <cond> is an optional matching condition. It makes it possible to match
8485 on a certain criterion only when other conditions are met (or
8486 not met). For instance, it could be used to match on a source IP
8487 address except when a request passes through a known proxy, in
8488 which case we'd match on a header containing that IP address.
8489
8490 Some protocols or applications require complex stickiness rules and cannot
8491 always simply rely on cookies nor hashing. The "stick match" statement
8492 describes a rule to extract the stickiness criterion from an incoming request
8493 or connection. See section 7 for a complete list of possible patterns and
8494 transformation rules.
8495
8496 The table has to be declared using the "stick-table" statement. It must be of
8497 a type compatible with the pattern. By default it is the one which is present
8498 in the same backend. It is possible to share a table with other backends by
8499 referencing it using the "table" keyword. If another table is referenced,
8500 the server's ID inside the backends are used. By default, all server IDs
8501 start at 1 in each backend, so the server ordering is enough. But in case of
8502 doubt, it is highly recommended to force server IDs using their "id" setting.
8503
8504 It is possible to restrict the conditions where a "stick match" statement
8505 will apply, using "if" or "unless" followed by a condition. See section 7 for
8506 ACL based conditions.
8507
8508 There is no limit on the number of "stick match" statements. The first that
8509 applies and matches will cause the request to be directed to the same server
8510 as was used for the request which created the entry. That way, multiple
8511 matches can be used as fallbacks.
8512
8513 The stick rules are checked after the persistence cookies, so they will not
8514 affect stickiness if a cookie has already been used to select a server. That
8515 way, it becomes very easy to insert cookies and match on IP addresses in
8516 order to maintain stickiness between HTTP and HTTPS.
8517
Cyril Bonté02ff8ef2010-12-14 22:48:49 +01008518 Note : Consider not using this feature in multi-process mode (nbproc > 1)
8519 unless you know what you do : memory is not shared between the
Davor Ocelice9ed2812017-12-25 17:49:28 +01008520 processes, which can result in random behaviors.
Cyril Bonté02ff8ef2010-12-14 22:48:49 +01008521
Willy Tarreaub937b7e2010-01-12 15:27:54 +01008522 Example :
8523 # forward SMTP users to the same server they just used for POP in the
8524 # last 30 minutes
8525 backend pop
8526 mode tcp
8527 balance roundrobin
8528 stick store-request src
8529 stick-table type ip size 200k expire 30m
8530 server s1 192.168.1.1:110
8531 server s2 192.168.1.1:110
8532
8533 backend smtp
8534 mode tcp
8535 balance roundrobin
8536 stick match src table pop
8537 server s1 192.168.1.1:25
8538 server s2 192.168.1.1:25
8539
Cyril Bonté02ff8ef2010-12-14 22:48:49 +01008540 See also : "stick-table", "stick on", "nbproc", "bind-process" and section 7
Willy Tarreaube722a22014-06-13 16:31:59 +02008541 about ACLs and samples fetching.
Willy Tarreaub937b7e2010-01-12 15:27:54 +01008542
8543
8544stick on <pattern> [table <table>] [{if | unless} <condition>]
8545 Define a request pattern to associate a user to a server
8546 May be used in sections : defaults | frontend | listen | backend
8547 no | no | yes | yes
8548
8549 Note : This form is exactly equivalent to "stick match" followed by
8550 "stick store-request", all with the same arguments. Please refer
8551 to both keywords for details. It is only provided as a convenience
8552 for writing more maintainable configurations.
8553
Cyril Bonté02ff8ef2010-12-14 22:48:49 +01008554 Note : Consider not using this feature in multi-process mode (nbproc > 1)
8555 unless you know what you do : memory is not shared between the
Davor Ocelice9ed2812017-12-25 17:49:28 +01008556 processes, which can result in random behaviors.
Cyril Bonté02ff8ef2010-12-14 22:48:49 +01008557
Willy Tarreaub937b7e2010-01-12 15:27:54 +01008558 Examples :
8559 # The following form ...
Willy Tarreauec579d82010-02-26 19:15:04 +01008560 stick on src table pop if !localhost
Willy Tarreaub937b7e2010-01-12 15:27:54 +01008561
8562 # ...is strictly equivalent to this one :
8563 stick match src table pop if !localhost
8564 stick store-request src table pop if !localhost
8565
8566
8567 # Use cookie persistence for HTTP, and stick on source address for HTTPS as
8568 # well as HTTP without cookie. Share the same table between both accesses.
8569 backend http
8570 mode http
8571 balance roundrobin
8572 stick on src table https
8573 cookie SRV insert indirect nocache
8574 server s1 192.168.1.1:80 cookie s1
8575 server s2 192.168.1.1:80 cookie s2
8576
8577 backend https
8578 mode tcp
8579 balance roundrobin
8580 stick-table type ip size 200k expire 30m
8581 stick on src
8582 server s1 192.168.1.1:443
8583 server s2 192.168.1.1:443
8584
Cyril Bonté02ff8ef2010-12-14 22:48:49 +01008585 See also : "stick match", "stick store-request", "nbproc" and "bind-process".
Willy Tarreaub937b7e2010-01-12 15:27:54 +01008586
8587
8588stick store-request <pattern> [table <table>] [{if | unless} <condition>]
8589 Define a request pattern used to create an entry in a stickiness table
8590 May be used in sections : defaults | frontend | listen | backend
8591 no | no | yes | yes
8592
8593 Arguments :
Willy Tarreaube722a22014-06-13 16:31:59 +02008594 <pattern> is a sample expression rule as described in section 7.3. It
Willy Tarreaub937b7e2010-01-12 15:27:54 +01008595 describes what elements of the incoming request or connection
Davor Ocelice9ed2812017-12-25 17:49:28 +01008596 will be analyzed, extracted and stored in the table once a
Willy Tarreaub937b7e2010-01-12 15:27:54 +01008597 server is selected.
8598
8599 <table> is an optional stickiness table name. If unspecified, the same
8600 backend's table is used. A stickiness table is declared using
8601 the "stick-table" statement.
8602
8603 <cond> is an optional storage condition. It makes it possible to store
8604 certain criteria only when some conditions are met (or not met).
8605 For instance, it could be used to store the source IP address
8606 except when the request passes through a known proxy, in which
8607 case we'd store a converted form of a header containing that IP
8608 address.
8609
8610 Some protocols or applications require complex stickiness rules and cannot
8611 always simply rely on cookies nor hashing. The "stick store-request" statement
8612 describes a rule to decide what to extract from the request and when to do
8613 it, in order to store it into a stickiness table for further requests to
8614 match it using the "stick match" statement. Obviously the extracted part must
8615 make sense and have a chance to be matched in a further request. Storing a
8616 client's IP address for instance often makes sense. Storing an ID found in a
8617 URL parameter also makes sense. Storing a source port will almost never make
8618 any sense because it will be randomly matched. See section 7 for a complete
8619 list of possible patterns and transformation rules.
8620
8621 The table has to be declared using the "stick-table" statement. It must be of
8622 a type compatible with the pattern. By default it is the one which is present
8623 in the same backend. It is possible to share a table with other backends by
8624 referencing it using the "table" keyword. If another table is referenced,
8625 the server's ID inside the backends are used. By default, all server IDs
8626 start at 1 in each backend, so the server ordering is enough. But in case of
8627 doubt, it is highly recommended to force server IDs using their "id" setting.
8628
8629 It is possible to restrict the conditions where a "stick store-request"
8630 statement will apply, using "if" or "unless" followed by a condition. This
8631 condition will be evaluated while parsing the request, so any criteria can be
8632 used. See section 7 for ACL based conditions.
8633
8634 There is no limit on the number of "stick store-request" statements, but
8635 there is a limit of 8 simultaneous stores per request or response. This
8636 makes it possible to store up to 8 criteria, all extracted from either the
8637 request or the response, regardless of the number of rules. Only the 8 first
8638 ones which match will be kept. Using this, it is possible to feed multiple
8639 tables at once in the hope to increase the chance to recognize a user on
Willy Tarreau9667a802013-12-09 12:52:13 +01008640 another protocol or access method. Using multiple store-request rules with
8641 the same table is possible and may be used to find the best criterion to rely
8642 on, by arranging the rules by decreasing preference order. Only the first
8643 extracted criterion for a given table will be stored. All subsequent store-
8644 request rules referencing the same table will be skipped and their ACLs will
8645 not be evaluated.
Willy Tarreaub937b7e2010-01-12 15:27:54 +01008646
8647 The "store-request" rules are evaluated once the server connection has been
8648 established, so that the table will contain the real server that processed
8649 the request.
8650
Cyril Bonté02ff8ef2010-12-14 22:48:49 +01008651 Note : Consider not using this feature in multi-process mode (nbproc > 1)
8652 unless you know what you do : memory is not shared between the
Davor Ocelice9ed2812017-12-25 17:49:28 +01008653 processes, which can result in random behaviors.
Cyril Bonté02ff8ef2010-12-14 22:48:49 +01008654
Willy Tarreaub937b7e2010-01-12 15:27:54 +01008655 Example :
8656 # forward SMTP users to the same server they just used for POP in the
8657 # last 30 minutes
8658 backend pop
8659 mode tcp
8660 balance roundrobin
8661 stick store-request src
8662 stick-table type ip size 200k expire 30m
8663 server s1 192.168.1.1:110
8664 server s2 192.168.1.1:110
8665
8666 backend smtp
8667 mode tcp
8668 balance roundrobin
8669 stick match src table pop
8670 server s1 192.168.1.1:25
8671 server s2 192.168.1.1:25
8672
Cyril Bonté02ff8ef2010-12-14 22:48:49 +01008673 See also : "stick-table", "stick on", "nbproc", "bind-process" and section 7
Willy Tarreaube722a22014-06-13 16:31:59 +02008674 about ACLs and sample fetching.
Willy Tarreaub937b7e2010-01-12 15:27:54 +01008675
8676
Emeric Brun7c6b82e2010-09-24 16:34:28 +02008677stick-table type {ip | integer | string [len <length>] | binary [len <length>]}
Emeric Brunf099e792010-09-27 12:05:28 +02008678 size <size> [expire <expire>] [nopurge] [peers <peersect>]
8679 [store <data_type>]*
Godbach64cef792013-12-04 16:08:22 +08008680 Configure the stickiness table for the current section
Willy Tarreaub937b7e2010-01-12 15:27:54 +01008681 May be used in sections : defaults | frontend | listen | backend
Willy Tarreauc00cdc22010-06-06 16:48:26 +02008682 no | yes | yes | yes
Willy Tarreaub937b7e2010-01-12 15:27:54 +01008683
8684 Arguments :
8685 ip a table declared with "type ip" will only store IPv4 addresses.
8686 This form is very compact (about 50 bytes per entry) and allows
8687 very fast entry lookup and stores with almost no overhead. This
8688 is mainly used to store client source IP addresses.
8689
David du Colombier9a6d3c92011-03-17 10:40:24 +01008690 ipv6 a table declared with "type ipv6" will only store IPv6 addresses.
8691 This form is very compact (about 60 bytes per entry) and allows
8692 very fast entry lookup and stores with almost no overhead. This
8693 is mainly used to store client source IP addresses.
8694
Willy Tarreaub937b7e2010-01-12 15:27:54 +01008695 integer a table declared with "type integer" will store 32bit integers
8696 which can represent a client identifier found in a request for
8697 instance.
8698
8699 string a table declared with "type string" will store substrings of up
8700 to <len> characters. If the string provided by the pattern
8701 extractor is larger than <len>, it will be truncated before
8702 being stored. During matching, at most <len> characters will be
8703 compared between the string in the table and the extracted
8704 pattern. When not specified, the string is automatically limited
Emeric Brun7c6b82e2010-09-24 16:34:28 +02008705 to 32 characters.
8706
8707 binary a table declared with "type binary" will store binary blocks
8708 of <len> bytes. If the block provided by the pattern
8709 extractor is larger than <len>, it will be truncated before
Willy Tarreaube722a22014-06-13 16:31:59 +02008710 being stored. If the block provided by the sample expression
Emeric Brun7c6b82e2010-09-24 16:34:28 +02008711 is shorter than <len>, it will be padded by 0. When not
8712 specified, the block is automatically limited to 32 bytes.
Willy Tarreaub937b7e2010-01-12 15:27:54 +01008713
8714 <length> is the maximum number of characters that will be stored in a
Emeric Brun7c6b82e2010-09-24 16:34:28 +02008715 "string" type table (See type "string" above). Or the number
8716 of bytes of the block in "binary" type table. Be careful when
Willy Tarreaub937b7e2010-01-12 15:27:54 +01008717 changing this parameter as memory usage will proportionally
8718 increase.
8719
8720 <size> is the maximum number of entries that can fit in the table. This
Cyril Bonté78caf842010-03-10 22:41:43 +01008721 value directly impacts memory usage. Count approximately
8722 50 bytes per entry, plus the size of a string if any. The size
8723 supports suffixes "k", "m", "g" for 2^10, 2^20 and 2^30 factors.
Willy Tarreaub937b7e2010-01-12 15:27:54 +01008724
8725 [nopurge] indicates that we refuse to purge older entries when the table
8726 is full. When not specified and the table is full when haproxy
8727 wants to store an entry in it, it will flush a few of the oldest
8728 entries in order to release some space for the new ones. This is
Davor Ocelice9ed2812017-12-25 17:49:28 +01008729 most often the desired behavior. In some specific cases, it
Willy Tarreaub937b7e2010-01-12 15:27:54 +01008730 be desirable to refuse new entries instead of purging the older
8731 ones. That may be the case when the amount of data to store is
8732 far above the hardware limits and we prefer not to offer access
8733 to new clients than to reject the ones already connected. When
8734 using this parameter, be sure to properly set the "expire"
8735 parameter (see below).
8736
Emeric Brunf099e792010-09-27 12:05:28 +02008737 <peersect> is the name of the peers section to use for replication. Entries
8738 which associate keys to server IDs are kept synchronized with
8739 the remote peers declared in this section. All entries are also
8740 automatically learned from the local peer (old process) during a
8741 soft restart.
8742
Willy Tarreau1abc6732015-05-01 19:21:02 +02008743 NOTE : each peers section may be referenced only by tables
8744 belonging to the same unique process.
Cyril Bonté02ff8ef2010-12-14 22:48:49 +01008745
Willy Tarreaub937b7e2010-01-12 15:27:54 +01008746 <expire> defines the maximum duration of an entry in the table since it
8747 was last created, refreshed or matched. The expiration delay is
8748 defined using the standard time format, similarly as the various
8749 timeouts. The maximum duration is slightly above 24 days. See
Jarno Huuskonene0ee0be2017-07-04 10:35:12 +03008750 section 2.4 for more information. If this delay is not specified,
Cyril Bontédc4d9032012-04-08 21:57:39 +02008751 the session won't automatically expire, but older entries will
Willy Tarreaub937b7e2010-01-12 15:27:54 +01008752 be removed once full. Be sure not to use the "nopurge" parameter
8753 if not expiration delay is specified.
8754
Willy Tarreau08d5f982010-06-06 13:34:54 +02008755 <data_type> is used to store additional information in the stick-table. This
8756 may be used by ACLs in order to control various criteria related
8757 to the activity of the client matching the stick-table. For each
8758 item specified here, the size of each entry will be inflated so
Willy Tarreauc9705a12010-07-27 20:05:50 +02008759 that the additional data can fit. Several data types may be
8760 stored with an entry. Multiple data types may be specified after
8761 the "store" keyword, as a comma-separated list. Alternatively,
8762 it is possible to repeat the "store" keyword followed by one or
8763 several data types. Except for the "server_id" type which is
8764 automatically detected and enabled, all data types must be
8765 explicitly declared to be stored. If an ACL references a data
8766 type which is not stored, the ACL will simply not match. Some
8767 data types require an argument which must be passed just after
8768 the type between parenthesis. See below for the supported data
8769 types and their arguments.
8770
8771 The data types that can be stored with an entry are the following :
8772 - server_id : this is an integer which holds the numeric ID of the server a
8773 request was assigned to. It is used by the "stick match", "stick store",
8774 and "stick on" rules. It is automatically enabled when referenced.
8775
8776 - gpc0 : first General Purpose Counter. It is a positive 32-bit integer
8777 integer which may be used for anything. Most of the time it will be used
8778 to put a special tag on some entries, for instance to note that a
Davor Ocelice9ed2812017-12-25 17:49:28 +01008779 specific behavior was detected and must be known for future matches.
Willy Tarreauc9705a12010-07-27 20:05:50 +02008780
Willy Tarreauba2ffd12013-05-29 15:54:14 +02008781 - gpc0_rate(<period>) : increment rate of the first General Purpose Counter
8782 over a period. It is a positive 32-bit integer integer which may be used
8783 for anything. Just like <gpc0>, it counts events, but instead of keeping
Davor Ocelice9ed2812017-12-25 17:49:28 +01008784 a cumulative number, it maintains the rate at which the counter is
Willy Tarreauba2ffd12013-05-29 15:54:14 +02008785 incremented. Most of the time it will be used to measure the frequency of
Davor Ocelice9ed2812017-12-25 17:49:28 +01008786 occurrence of certain events (e.g. requests to a specific URL).
Willy Tarreauba2ffd12013-05-29 15:54:14 +02008787
Frédéric Lécaille6778b272018-01-29 15:22:53 +01008788 - gpc1 : second General Purpose Counter. It is a positive 32-bit integer
8789 integer which may be used for anything. Most of the time it will be used
8790 to put a special tag on some entries, for instance to note that a
8791 specific behavior was detected and must be known for future matches.
8792
8793 - gpc1_rate(<period>) : increment rate of the second General Purpose Counter
8794 over a period. It is a positive 32-bit integer integer which may be used
8795 for anything. Just like <gpc1>, it counts events, but instead of keeping
8796 a cumulative number, it maintains the rate at which the counter is
8797 incremented. Most of the time it will be used to measure the frequency of
8798 occurrence of certain events (e.g. requests to a specific URL).
8799
Willy Tarreauc9705a12010-07-27 20:05:50 +02008800 - conn_cnt : Connection Count. It is a positive 32-bit integer which counts
8801 the absolute number of connections received from clients which matched
8802 this entry. It does not mean the connections were accepted, just that
8803 they were received.
8804
8805 - conn_cur : Current Connections. It is a positive 32-bit integer which
8806 stores the concurrent connection counts for the entry. It is incremented
8807 once an incoming connection matches the entry, and decremented once the
8808 connection leaves. That way it is possible to know at any time the exact
8809 number of concurrent connections for an entry.
8810
8811 - conn_rate(<period>) : frequency counter (takes 12 bytes). It takes an
8812 integer parameter <period> which indicates in milliseconds the length
8813 of the period over which the average is measured. It reports the average
8814 incoming connection rate over that period, in connections per period. The
8815 result is an integer which can be matched using ACLs.
8816
8817 - sess_cnt : Session Count. It is a positive 32-bit integer which counts
8818 the absolute number of sessions received from clients which matched this
8819 entry. A session is a connection that was accepted by the layer 4 rules.
8820
8821 - sess_rate(<period>) : frequency counter (takes 12 bytes). It takes an
8822 integer parameter <period> which indicates in milliseconds the length
8823 of the period over which the average is measured. It reports the average
8824 incoming session rate over that period, in sessions per period. The
8825 result is an integer which can be matched using ACLs.
8826
8827 - http_req_cnt : HTTP request Count. It is a positive 32-bit integer which
8828 counts the absolute number of HTTP requests received from clients which
8829 matched this entry. It does not matter whether they are valid requests or
8830 not. Note that this is different from sessions when keep-alive is used on
8831 the client side.
8832
8833 - http_req_rate(<period>) : frequency counter (takes 12 bytes). It takes an
8834 integer parameter <period> which indicates in milliseconds the length
8835 of the period over which the average is measured. It reports the average
8836 HTTP request rate over that period, in requests per period. The result is
8837 an integer which can be matched using ACLs. It does not matter whether
8838 they are valid requests or not. Note that this is different from sessions
8839 when keep-alive is used on the client side.
8840
8841 - http_err_cnt : HTTP Error Count. It is a positive 32-bit integer which
8842 counts the absolute number of HTTP requests errors induced by clients
8843 which matched this entry. Errors are counted on invalid and truncated
8844 requests, as well as on denied or tarpitted requests, and on failed
8845 authentications. If the server responds with 4xx, then the request is
8846 also counted as an error since it's an error triggered by the client
Davor Ocelice9ed2812017-12-25 17:49:28 +01008847 (e.g. vulnerability scan).
Willy Tarreauc9705a12010-07-27 20:05:50 +02008848
8849 - http_err_rate(<period>) : frequency counter (takes 12 bytes). It takes an
8850 integer parameter <period> which indicates in milliseconds the length
8851 of the period over which the average is measured. It reports the average
8852 HTTP request error rate over that period, in requests per period (see
8853 http_err_cnt above for what is accounted as an error). The result is an
8854 integer which can be matched using ACLs.
8855
8856 - bytes_in_cnt : client to server byte count. It is a positive 64-bit
Davor Ocelice9ed2812017-12-25 17:49:28 +01008857 integer which counts the cumulative number of bytes received from clients
Willy Tarreauc9705a12010-07-27 20:05:50 +02008858 which matched this entry. Headers are included in the count. This may be
8859 used to limit abuse of upload features on photo or video servers.
8860
8861 - bytes_in_rate(<period>) : frequency counter (takes 12 bytes). It takes an
8862 integer parameter <period> which indicates in milliseconds the length
8863 of the period over which the average is measured. It reports the average
8864 incoming bytes rate over that period, in bytes per period. It may be used
8865 to detect users which upload too much and too fast. Warning: with large
8866 uploads, it is possible that the amount of uploaded data will be counted
8867 once upon termination, thus causing spikes in the average transfer speed
8868 instead of having a smooth one. This may partially be smoothed with
8869 "option contstats" though this is not perfect yet. Use of byte_in_cnt is
8870 recommended for better fairness.
8871
8872 - bytes_out_cnt : server to client byte count. It is a positive 64-bit
Davor Ocelice9ed2812017-12-25 17:49:28 +01008873 integer which counts the cumulative number of bytes sent to clients which
Willy Tarreauc9705a12010-07-27 20:05:50 +02008874 matched this entry. Headers are included in the count. This may be used
8875 to limit abuse of bots sucking the whole site.
8876
8877 - bytes_out_rate(<period>) : frequency counter (takes 12 bytes). It takes
8878 an integer parameter <period> which indicates in milliseconds the length
8879 of the period over which the average is measured. It reports the average
8880 outgoing bytes rate over that period, in bytes per period. It may be used
8881 to detect users which download too much and too fast. Warning: with large
8882 transfers, it is possible that the amount of transferred data will be
8883 counted once upon termination, thus causing spikes in the average
8884 transfer speed instead of having a smooth one. This may partially be
8885 smoothed with "option contstats" though this is not perfect yet. Use of
8886 byte_out_cnt is recommended for better fairness.
Willy Tarreau08d5f982010-06-06 13:34:54 +02008887
Willy Tarreauc00cdc22010-06-06 16:48:26 +02008888 There is only one stick-table per proxy. At the moment of writing this doc,
8889 it does not seem useful to have multiple tables per proxy. If this happens
Willy Tarreaub937b7e2010-01-12 15:27:54 +01008890 to be required, simply create a dummy backend with a stick-table in it and
8891 reference it.
8892
8893 It is important to understand that stickiness based on learning information
8894 has some limitations, including the fact that all learned associations are
Baptiste Assmann123ff042016-03-06 23:29:28 +01008895 lost upon restart unless peers are properly configured to transfer such
8896 information upon restart (recommended). In general it can be good as a
8897 complement but not always as an exclusive stickiness.
Willy Tarreaub937b7e2010-01-12 15:27:54 +01008898
Willy Tarreauc9705a12010-07-27 20:05:50 +02008899 Last, memory requirements may be important when storing many data types.
8900 Indeed, storing all indicators above at once in each entry requires 116 bytes
8901 per entry, or 116 MB for a 1-million entries table. This is definitely not
8902 something that can be ignored.
8903
8904 Example:
8905 # Keep track of counters of up to 1 million IP addresses over 5 minutes
8906 # and store a general purpose counter and the average connection rate
8907 # computed over a sliding window of 30 seconds.
8908 stick-table type ip size 1m expire 5m store gpc0,conn_rate(30s)
8909
Jarno Huuskonene0ee0be2017-07-04 10:35:12 +03008910 See also : "stick match", "stick on", "stick store-request", section 2.4
David du Colombiera13d1b92011-03-17 10:40:22 +01008911 about time format and section 7 about ACLs.
Willy Tarreaub937b7e2010-01-12 15:27:54 +01008912
8913
Emeric Brun6a1cefa2010-09-24 18:15:17 +02008914stick store-response <pattern> [table <table>] [{if | unless} <condition>]
Baptiste Assmann2f2d2ec2016-03-06 23:27:24 +01008915 Define a response pattern used to create an entry in a stickiness table
Emeric Brun6a1cefa2010-09-24 18:15:17 +02008916 May be used in sections : defaults | frontend | listen | backend
8917 no | no | yes | yes
8918
8919 Arguments :
Willy Tarreaube722a22014-06-13 16:31:59 +02008920 <pattern> is a sample expression rule as described in section 7.3. It
Emeric Brun6a1cefa2010-09-24 18:15:17 +02008921 describes what elements of the response or connection will
Davor Ocelice9ed2812017-12-25 17:49:28 +01008922 be analyzed, extracted and stored in the table once a
Emeric Brun6a1cefa2010-09-24 18:15:17 +02008923 server is selected.
8924
8925 <table> is an optional stickiness table name. If unspecified, the same
8926 backend's table is used. A stickiness table is declared using
8927 the "stick-table" statement.
8928
8929 <cond> is an optional storage condition. It makes it possible to store
8930 certain criteria only when some conditions are met (or not met).
8931 For instance, it could be used to store the SSL session ID only
8932 when the response is a SSL server hello.
8933
8934 Some protocols or applications require complex stickiness rules and cannot
8935 always simply rely on cookies nor hashing. The "stick store-response"
8936 statement describes a rule to decide what to extract from the response and
8937 when to do it, in order to store it into a stickiness table for further
8938 requests to match it using the "stick match" statement. Obviously the
8939 extracted part must make sense and have a chance to be matched in a further
Cyril Bonté108cf6e2012-04-21 23:30:29 +02008940 request. Storing an ID found in a header of a response makes sense.
Emeric Brun6a1cefa2010-09-24 18:15:17 +02008941 See section 7 for a complete list of possible patterns and transformation
8942 rules.
8943
8944 The table has to be declared using the "stick-table" statement. It must be of
8945 a type compatible with the pattern. By default it is the one which is present
8946 in the same backend. It is possible to share a table with other backends by
8947 referencing it using the "table" keyword. If another table is referenced,
8948 the server's ID inside the backends are used. By default, all server IDs
8949 start at 1 in each backend, so the server ordering is enough. But in case of
8950 doubt, it is highly recommended to force server IDs using their "id" setting.
8951
8952 It is possible to restrict the conditions where a "stick store-response"
8953 statement will apply, using "if" or "unless" followed by a condition. This
8954 condition will be evaluated while parsing the response, so any criteria can
8955 be used. See section 7 for ACL based conditions.
8956
8957 There is no limit on the number of "stick store-response" statements, but
8958 there is a limit of 8 simultaneous stores per request or response. This
8959 makes it possible to store up to 8 criteria, all extracted from either the
8960 request or the response, regardless of the number of rules. Only the 8 first
8961 ones which match will be kept. Using this, it is possible to feed multiple
8962 tables at once in the hope to increase the chance to recognize a user on
Willy Tarreau9667a802013-12-09 12:52:13 +01008963 another protocol or access method. Using multiple store-response rules with
8964 the same table is possible and may be used to find the best criterion to rely
8965 on, by arranging the rules by decreasing preference order. Only the first
8966 extracted criterion for a given table will be stored. All subsequent store-
8967 response rules referencing the same table will be skipped and their ACLs will
8968 not be evaluated. However, even if a store-request rule references a table, a
8969 store-response rule may also use the same table. This means that each table
8970 may learn exactly one element from the request and one element from the
8971 response at once.
Emeric Brun6a1cefa2010-09-24 18:15:17 +02008972
8973 The table will contain the real server that processed the request.
8974
8975 Example :
8976 # Learn SSL session ID from both request and response and create affinity.
8977 backend https
8978 mode tcp
8979 balance roundrobin
Cyril Bontédc4d9032012-04-08 21:57:39 +02008980 # maximum SSL session ID length is 32 bytes.
Emeric Brun6a1cefa2010-09-24 18:15:17 +02008981 stick-table type binary len 32 size 30k expire 30m
Cyril Bonté108cf6e2012-04-21 23:30:29 +02008982
Emeric Brun6a1cefa2010-09-24 18:15:17 +02008983 acl clienthello req_ssl_hello_type 1
8984 acl serverhello rep_ssl_hello_type 2
8985
8986 # use tcp content accepts to detects ssl client and server hello.
8987 tcp-request inspect-delay 5s
8988 tcp-request content accept if clienthello
8989
8990 # no timeout on response inspect delay by default.
8991 tcp-response content accept if serverhello
Cyril Bonté108cf6e2012-04-21 23:30:29 +02008992
Emeric Brun6a1cefa2010-09-24 18:15:17 +02008993 # SSL session ID (SSLID) may be present on a client or server hello.
8994 # Its length is coded on 1 byte at offset 43 and its value starts
8995 # at offset 44.
8996
8997 # Match and learn on request if client hello.
8998 stick on payload_lv(43,1) if clienthello
8999
9000 # Learn on response if server hello.
9001 stick store-response payload_lv(43,1) if serverhello
Cyril Bontédc4d9032012-04-08 21:57:39 +02009002
Emeric Brun6a1cefa2010-09-24 18:15:17 +02009003 server s1 192.168.1.1:443
9004 server s2 192.168.1.1:443
9005
9006 See also : "stick-table", "stick on", and section 7 about ACLs and pattern
9007 extraction.
9008
9009
Willy Tarreau938c7fe2014-04-25 14:21:39 +02009010tcp-check connect [params*]
9011 Opens a new connection
9012 May be used in sections: defaults | frontend | listen | backend
9013 no | no | yes | yes
9014
9015 When an application lies on more than a single TCP port or when HAProxy
9016 load-balance many services in a single backend, it makes sense to probe all
9017 the services individually before considering a server as operational.
9018
9019 When there are no TCP port configured on the server line neither server port
9020 directive, then the 'tcp-check connect port <port>' must be the first step
9021 of the sequence.
9022
9023 In a tcp-check ruleset a 'connect' is required, it is also mandatory to start
9024 the ruleset with a 'connect' rule. Purpose is to ensure admin know what they
9025 do.
9026
9027 Parameters :
9028 They are optional and can be used to describe how HAProxy should open and
9029 use the TCP connection.
9030
9031 port if not set, check port or server port is used.
9032 It tells HAProxy where to open the connection to.
9033 <port> must be a valid TCP port source integer, from 1 to 65535.
9034
9035 send-proxy send a PROXY protocol string
9036
9037 ssl opens a ciphered connection
9038
9039 Examples:
9040 # check HTTP and HTTPs services on a server.
9041 # first open port 80 thanks to server line port directive, then
9042 # tcp-check opens port 443, ciphered and run a request on it:
9043 option tcp-check
9044 tcp-check connect
9045 tcp-check send GET\ /\ HTTP/1.0\r\n
9046 tcp-check send Host:\ haproxy.1wt.eu\r\n
9047 tcp-check send \r\n
9048 tcp-check expect rstring (2..|3..)
9049 tcp-check connect port 443 ssl
9050 tcp-check send GET\ /\ HTTP/1.0\r\n
9051 tcp-check send Host:\ haproxy.1wt.eu\r\n
9052 tcp-check send \r\n
9053 tcp-check expect rstring (2..|3..)
9054 server www 10.0.0.1 check port 80
9055
9056 # check both POP and IMAP from a single server:
9057 option tcp-check
9058 tcp-check connect port 110
9059 tcp-check expect string +OK\ POP3\ ready
9060 tcp-check connect port 143
9061 tcp-check expect string *\ OK\ IMAP4\ ready
9062 server mail 10.0.0.1 check
9063
9064 See also : "option tcp-check", "tcp-check send", "tcp-check expect"
9065
9066
9067tcp-check expect [!] <match> <pattern>
Davor Ocelice9ed2812017-12-25 17:49:28 +01009068 Specify data to be collected and analyzed during a generic health check
Willy Tarreau938c7fe2014-04-25 14:21:39 +02009069 May be used in sections: defaults | frontend | listen | backend
9070 no | no | yes | yes
9071
9072 Arguments :
9073 <match> is a keyword indicating how to look for a specific pattern in the
9074 response. The keyword may be one of "string", "rstring" or
9075 binary.
9076 The keyword may be preceded by an exclamation mark ("!") to negate
9077 the match. Spaces are allowed between the exclamation mark and the
9078 keyword. See below for more details on the supported keywords.
9079
9080 <pattern> is the pattern to look for. It may be a string or a regular
9081 expression. If the pattern contains spaces, they must be escaped
9082 with the usual backslash ('\').
9083 If the match is set to binary, then the pattern must be passed as
Davor Ocelice9ed2812017-12-25 17:49:28 +01009084 a series of hexadecimal digits in an even number. Each sequence of
Willy Tarreau938c7fe2014-04-25 14:21:39 +02009085 two digits will represent a byte. The hexadecimal digits may be
9086 used upper or lower case.
9087
9088
9089 The available matches are intentionally similar to their http-check cousins :
9090
9091 string <string> : test the exact string matches in the response buffer.
9092 A health check response will be considered valid if the
9093 response's buffer contains this exact string. If the
9094 "string" keyword is prefixed with "!", then the response
9095 will be considered invalid if the body contains this
9096 string. This can be used to look for a mandatory pattern
9097 in a protocol response, or to detect a failure when a
9098 specific error appears in a protocol banner.
9099
9100 rstring <regex> : test a regular expression on the response buffer.
9101 A health check response will be considered valid if the
9102 response's buffer matches this expression. If the
9103 "rstring" keyword is prefixed with "!", then the response
9104 will be considered invalid if the body matches the
9105 expression.
9106
9107 binary <hexstring> : test the exact string in its hexadecimal form matches
9108 in the response buffer. A health check response will
9109 be considered valid if the response's buffer contains
9110 this exact hexadecimal string.
9111 Purpose is to match data on binary protocols.
9112
9113 It is important to note that the responses will be limited to a certain size
9114 defined by the global "tune.chksize" option, which defaults to 16384 bytes.
9115 Thus, too large responses may not contain the mandatory pattern when using
9116 "string", "rstring" or binary. If a large response is absolutely required, it
9117 is possible to change the default max size by setting the global variable.
9118 However, it is worth keeping in mind that parsing very large responses can
9119 waste some CPU cycles, especially when regular expressions are used, and that
9120 it is always better to focus the checks on smaller resources. Also, in its
9121 current state, the check will not find any string nor regex past a null
9122 character in the response. Similarly it is not possible to request matching
9123 the null character.
9124
9125 Examples :
9126 # perform a POP check
9127 option tcp-check
9128 tcp-check expect string +OK\ POP3\ ready
9129
9130 # perform an IMAP check
9131 option tcp-check
9132 tcp-check expect string *\ OK\ IMAP4\ ready
9133
9134 # look for the redis master server
9135 option tcp-check
9136 tcp-check send PING\r\n
Baptiste Assmanna3322992015-08-04 10:12:18 +02009137 tcp-check expect string +PONG
Willy Tarreau938c7fe2014-04-25 14:21:39 +02009138 tcp-check send info\ replication\r\n
9139 tcp-check expect string role:master
9140 tcp-check send QUIT\r\n
9141 tcp-check expect string +OK
9142
9143
9144 See also : "option tcp-check", "tcp-check connect", "tcp-check send",
9145 "tcp-check send-binary", "http-check expect", tune.chksize
9146
9147
9148tcp-check send <data>
9149 Specify a string to be sent as a question during a generic health check
9150 May be used in sections: defaults | frontend | listen | backend
9151 no | no | yes | yes
9152
9153 <data> : the data to be sent as a question during a generic health check
9154 session. For now, <data> must be a string.
9155
9156 Examples :
9157 # look for the redis master server
9158 option tcp-check
9159 tcp-check send info\ replication\r\n
9160 tcp-check expect string role:master
9161
9162 See also : "option tcp-check", "tcp-check connect", "tcp-check expect",
9163 "tcp-check send-binary", tune.chksize
9164
9165
Davor Ocelice9ed2812017-12-25 17:49:28 +01009166tcp-check send-binary <hexstring>
9167 Specify a hex digits string to be sent as a binary question during a raw
Willy Tarreau938c7fe2014-04-25 14:21:39 +02009168 tcp health check
9169 May be used in sections: defaults | frontend | listen | backend
9170 no | no | yes | yes
9171
9172 <data> : the data to be sent as a question during a generic health check
9173 session. For now, <data> must be a string.
Davor Ocelice9ed2812017-12-25 17:49:28 +01009174 <hexstring> : test the exact string in its hexadecimal form matches in the
Willy Tarreau938c7fe2014-04-25 14:21:39 +02009175 response buffer. A health check response will be considered
9176 valid if the response's buffer contains this exact
9177 hexadecimal string.
9178 Purpose is to send binary data to ask on binary protocols.
9179
9180 Examples :
9181 # redis check in binary
9182 option tcp-check
9183 tcp-check send-binary 50494e470d0a # PING\r\n
9184 tcp-check expect binary 2b504F4e47 # +PONG
9185
9186
9187 See also : "option tcp-check", "tcp-check connect", "tcp-check expect",
9188 "tcp-check send", tune.chksize
9189
9190
Willy Tarreaue9656522010-08-17 15:40:09 +02009191tcp-request connection <action> [{if | unless} <condition>]
9192 Perform an action on an incoming connection depending on a layer 4 condition
Willy Tarreau1a687942010-05-23 22:40:30 +02009193 May be used in sections : defaults | frontend | listen | backend
9194 no | yes | yes | no
Willy Tarreaue9656522010-08-17 15:40:09 +02009195 Arguments :
Willy Tarreauc870bfd2015-09-28 18:47:38 +02009196 <action> defines the action to perform if the condition applies. See
9197 below.
Willy Tarreau1a687942010-05-23 22:40:30 +02009198
Willy Tarreaue9656522010-08-17 15:40:09 +02009199 <condition> is a standard layer4-only ACL-based condition (see section 7).
Willy Tarreau68c03ab2010-08-06 15:08:45 +02009200
9201 Immediately after acceptance of a new incoming connection, it is possible to
9202 evaluate some conditions to decide whether this connection must be accepted
Willy Tarreaue9656522010-08-17 15:40:09 +02009203 or dropped or have its counters tracked. Those conditions cannot make use of
9204 any data contents because the connection has not been read from yet, and the
9205 buffers are not yet allocated. This is used to selectively and very quickly
9206 accept or drop connections from various sources with a very low overhead. If
9207 some contents need to be inspected in order to take the decision, the
9208 "tcp-request content" statements must be used instead.
Willy Tarreau68c03ab2010-08-06 15:08:45 +02009209
Willy Tarreaue9656522010-08-17 15:40:09 +02009210 The "tcp-request connection" rules are evaluated in their exact declaration
9211 order. If no rule matches or if there is no rule, the default action is to
9212 accept the incoming connection. There is no specific limit to the number of
9213 rules which may be inserted.
Willy Tarreau68c03ab2010-08-06 15:08:45 +02009214
Willy Tarreaua9083d02015-05-08 15:27:59 +02009215 Four types of actions are supported :
Willy Tarreaue9656522010-08-17 15:40:09 +02009216 - accept :
9217 accepts the connection if the condition is true (when used with "if")
9218 or false (when used with "unless"). The first such rule executed ends
9219 the rules evaluation.
Willy Tarreau68c03ab2010-08-06 15:08:45 +02009220
Willy Tarreaue9656522010-08-17 15:40:09 +02009221 - reject :
9222 rejects the connection if the condition is true (when used with "if")
9223 or false (when used with "unless"). The first such rule executed ends
9224 the rules evaluation. Rejected connections do not even become a
9225 session, which is why they are accounted separately for in the stats,
9226 as "denied connections". They are not considered for the session
9227 rate-limit and are not logged either. The reason is that these rules
9228 should only be used to filter extremely high connection rates such as
9229 the ones encountered during a massive DDoS attack. Under these extreme
9230 conditions, the simple action of logging each event would make the
9231 system collapse and would considerably lower the filtering capacity. If
9232 logging is absolutely desired, then "tcp-request content" rules should
Willy Tarreau4f614292016-10-21 17:49:36 +02009233 be used instead, as "tcp-request session" rules will not log either.
Willy Tarreau68c03ab2010-08-06 15:08:45 +02009234
Willy Tarreau4f0d9192013-06-11 20:40:55 +02009235 - expect-proxy layer4 :
9236 configures the client-facing connection to receive a PROXY protocol
9237 header before any byte is read from the socket. This is equivalent to
9238 having the "accept-proxy" keyword on the "bind" line, except that using
9239 the TCP rule allows the PROXY protocol to be accepted only for certain
9240 IP address ranges using an ACL. This is convenient when multiple layers
9241 of load balancers are passed through by traffic coming from public
9242 hosts.
9243
Bertrand Jacquin90759682016-06-06 15:35:39 +01009244 - expect-netscaler-cip layer4 :
9245 configures the client-facing connection to receive a NetScaler Client
9246 IP insertion protocol header before any byte is read from the socket.
9247 This is equivalent to having the "accept-netscaler-cip" keyword on the
9248 "bind" line, except that using the TCP rule allows the PROXY protocol
9249 to be accepted only for certain IP address ranges using an ACL. This
9250 is convenient when multiple layers of load balancers are passed
9251 through by traffic coming from public hosts.
9252
Willy Tarreau18bf01e2014-06-13 16:18:52 +02009253 - capture <sample> len <length> :
9254 This only applies to "tcp-request content" rules. It captures sample
9255 expression <sample> from the request buffer, and converts it to a
9256 string of at most <len> characters. The resulting string is stored into
9257 the next request "capture" slot, so it will possibly appear next to
9258 some captured HTTP headers. It will then automatically appear in the
9259 logs, and it will be possible to extract it using sample fetch rules to
9260 feed it into headers or anything. The length should be limited given
9261 that this size will be allocated for each capture during the whole
Willy Tarreaua9083d02015-05-08 15:27:59 +02009262 session life. Please check section 7.3 (Fetching samples) and "capture
9263 request header" for more information.
Willy Tarreau18bf01e2014-06-13 16:18:52 +02009264
Willy Tarreaube4a3ef2013-06-17 15:04:07 +02009265 - { track-sc0 | track-sc1 | track-sc2 } <key> [table <table>] :
Willy Tarreaue9656522010-08-17 15:40:09 +02009266 enables tracking of sticky counters from current connection. These
Willy Tarreau09448f72014-06-25 18:12:15 +02009267 rules do not stop evaluation and do not change default action. 3 sets
Willy Tarreaue9656522010-08-17 15:40:09 +02009268 of counters may be simultaneously tracked by the same connection. The
Willy Tarreaube4a3ef2013-06-17 15:04:07 +02009269 first "track-sc0" rule executed enables tracking of the counters of the
9270 specified table as the first set. The first "track-sc1" rule executed
Willy Tarreaue9656522010-08-17 15:40:09 +02009271 enables tracking of the counters of the specified table as the second
Willy Tarreaube4a3ef2013-06-17 15:04:07 +02009272 set. The first "track-sc2" rule executed enables tracking of the
9273 counters of the specified table as the third set. It is a recommended
9274 practice to use the first set of counters for the per-frontend counters
9275 and the second set for the per-backend ones. But this is just a
9276 guideline, all may be used everywhere.
Willy Tarreau68c03ab2010-08-06 15:08:45 +02009277
Willy Tarreaue9656522010-08-17 15:40:09 +02009278 These actions take one or two arguments :
Willy Tarreaube722a22014-06-13 16:31:59 +02009279 <key> is mandatory, and is a sample expression rule as described
Willy Tarreau74ca5042013-06-11 23:12:07 +02009280 in section 7.3. It describes what elements of the incoming
Davor Ocelice9ed2812017-12-25 17:49:28 +01009281 request or connection will be analyzed, extracted, combined,
Willy Tarreau5d5b5d82012-12-09 12:00:04 +01009282 and used to select which table entry to update the counters.
9283 Note that "tcp-request connection" cannot use content-based
9284 fetches.
Willy Tarreau68c03ab2010-08-06 15:08:45 +02009285
Willy Tarreaue9656522010-08-17 15:40:09 +02009286 <table> is an optional table to be used instead of the default one,
9287 which is the stick-table declared in the current proxy. All
9288 the counters for the matches and updates for the key will
9289 then be performed in that table until the session ends.
Willy Tarreau68c03ab2010-08-06 15:08:45 +02009290
Willy Tarreaue9656522010-08-17 15:40:09 +02009291 Once a "track-sc*" rule is executed, the key is looked up in the table
9292 and if it is not found, an entry is allocated for it. Then a pointer to
9293 that entry is kept during all the session's life, and this entry's
9294 counters are updated as often as possible, every time the session's
9295 counters are updated, and also systematically when the session ends.
Willy Tarreau5d5b5d82012-12-09 12:00:04 +01009296 Counters are only updated for events that happen after the tracking has
9297 been started. For example, connection counters will not be updated when
9298 tracking layer 7 information, since the connection event happens before
9299 layer7 information is extracted.
9300
Willy Tarreaue9656522010-08-17 15:40:09 +02009301 If the entry tracks concurrent connection counters, one connection is
9302 counted for as long as the entry is tracked, and the entry will not
9303 expire during that time. Tracking counters also provides a performance
9304 advantage over just checking the keys, because only one table lookup is
9305 performed for all ACL checks that make use of it.
Willy Tarreau68c03ab2010-08-06 15:08:45 +02009306
Thierry FOURNIERe0627bd2015-08-04 08:20:33 +02009307 - sc-inc-gpc0(<sc-id>):
9308 The "sc-inc-gpc0" increments the GPC0 counter according to the sticky
9309 counter designated by <sc-id>. If an error occurs, this action silently
9310 fails and the actions evaluation continues.
9311
Frédéric Lécaille6778b272018-01-29 15:22:53 +01009312 - sc-inc-gpc1(<sc-id>):
9313 The "sc-inc-gpc1" increments the GPC1 counter according to the sticky
9314 counter designated by <sc-id>. If an error occurs, this action silently
9315 fails and the actions evaluation continues.
9316
Thierry FOURNIER236657b2015-08-19 08:25:14 +02009317 - sc-set-gpt0(<sc-id>) <int>:
9318 This action sets the GPT0 tag according to the sticky counter designated
9319 by <sc-id> and the value of <int>. The expected result is a boolean. If
9320 an error occurs, this action silently fails and the actions evaluation
9321 continues.
9322
William Lallemand2e785f22016-05-25 01:48:42 +02009323 - set-src <expr> :
9324 Is used to set the source IP address to the value of specified
9325 expression. Useful if you want to mask source IP for privacy.
9326 If you want to provide an IP from a HTTP header use "http-request
9327 set-src"
9328
9329 <expr> Is a standard HAProxy expression formed by a sample-fetch
9330 followed by some converters.
9331
9332 Example:
9333
9334 tcp-request connection set-src src,ipmask(24)
9335
Willy Tarreau0c630532016-10-21 17:52:58 +02009336 When possible, set-src preserves the original source port as long as the
9337 address family allows it, otherwise the source port is set to 0.
William Lallemand2e785f22016-05-25 01:48:42 +02009338
William Lallemand44be6402016-05-25 01:51:35 +02009339 - set-src-port <expr> :
9340 Is used to set the source port address to the value of specified
9341 expression.
9342
9343 <expr> Is a standard HAProxy expression formed by a sample-fetch
9344 followed by some converters.
9345
9346 Example:
9347
9348 tcp-request connection set-src-port int(4000)
9349
Willy Tarreau0c630532016-10-21 17:52:58 +02009350 When possible, set-src-port preserves the original source address as long
9351 as the address family supports a port, otherwise it forces the source
9352 address to IPv4 "0.0.0.0" before rewriting the port.
William Lallemand44be6402016-05-25 01:51:35 +02009353
William Lallemand13e9b0c2016-05-25 02:34:07 +02009354 - set-dst <expr> :
9355 Is used to set the destination IP address to the value of specified
9356 expression. Useful if you want to mask IP for privacy in log.
9357 If you want to provide an IP from a HTTP header use "http-request
9358 set-dst". If you want to connect to the new address/port, use
9359 '0.0.0.0:0' as a server address in the backend.
9360
9361 <expr> Is a standard HAProxy expression formed by a sample-fetch
9362 followed by some converters.
9363
9364 Example:
9365
9366 tcp-request connection set-dst dst,ipmask(24)
9367 tcp-request connection set-dst ipv4(10.0.0.1)
9368
Willy Tarreau0c630532016-10-21 17:52:58 +02009369 When possible, set-dst preserves the original destination port as long as
9370 the address family allows it, otherwise the destination port is set to 0.
9371
William Lallemand13e9b0c2016-05-25 02:34:07 +02009372 - set-dst-port <expr> :
9373 Is used to set the destination port address to the value of specified
9374 expression. If you want to connect to the new address/port, use
9375 '0.0.0.0:0' as a server address in the backend.
9376
9377
9378 <expr> Is a standard HAProxy expression formed by a sample-fetch
9379 followed by some converters.
9380
9381 Example:
9382
9383 tcp-request connection set-dst-port int(4000)
9384
Willy Tarreau0c630532016-10-21 17:52:58 +02009385 When possible, set-dst-port preserves the original destination address as
9386 long as the address family supports a port, otherwise it forces the
9387 destination address to IPv4 "0.0.0.0" before rewriting the port.
9388
Willy Tarreau2d392c22015-08-24 01:43:45 +02009389 - "silent-drop" :
9390 This stops the evaluation of the rules and makes the client-facing
Davor Ocelice9ed2812017-12-25 17:49:28 +01009391 connection suddenly disappear using a system-dependent way that tries
Willy Tarreau2d392c22015-08-24 01:43:45 +02009392 to prevent the client from being notified. The effect it then that the
9393 client still sees an established connection while there's none on
9394 HAProxy. The purpose is to achieve a comparable effect to "tarpit"
9395 except that it doesn't use any local resource at all on the machine
9396 running HAProxy. It can resist much higher loads than "tarpit", and
Davor Ocelice9ed2812017-12-25 17:49:28 +01009397 slow down stronger attackers. It is important to understand the impact
9398 of using this mechanism. All stateful equipment placed between the
Willy Tarreau2d392c22015-08-24 01:43:45 +02009399 client and HAProxy (firewalls, proxies, load balancers) will also keep
9400 the established connection for a long time and may suffer from this
Davor Ocelice9ed2812017-12-25 17:49:28 +01009401 action. On modern Linux systems running with enough privileges, the
Willy Tarreau2d392c22015-08-24 01:43:45 +02009402 TCP_REPAIR socket option is used to block the emission of a TCP
9403 reset. On other systems, the socket's TTL is reduced to 1 so that the
9404 TCP reset doesn't pass the first router, though it's still delivered to
9405 local networks. Do not use it unless you fully understand how it works.
9406
Willy Tarreaue9656522010-08-17 15:40:09 +02009407 Note that the "if/unless" condition is optional. If no condition is set on
9408 the action, it is simply performed unconditionally. That can be useful for
9409 "track-sc*" actions as well as for changing the default action to a reject.
Willy Tarreau68c03ab2010-08-06 15:08:45 +02009410
Willy Tarreaue9656522010-08-17 15:40:09 +02009411 Example: accept all connections from white-listed hosts, reject too fast
9412 connection without counting them, and track accepted connections.
9413 This results in connection rate being capped from abusive sources.
Willy Tarreau68c03ab2010-08-06 15:08:45 +02009414
Willy Tarreaue9656522010-08-17 15:40:09 +02009415 tcp-request connection accept if { src -f /etc/haproxy/whitelist.lst }
Willy Tarreau68c03ab2010-08-06 15:08:45 +02009416 tcp-request connection reject if { src_conn_rate gt 10 }
Willy Tarreaube4a3ef2013-06-17 15:04:07 +02009417 tcp-request connection track-sc0 src
Willy Tarreau68c03ab2010-08-06 15:08:45 +02009418
Willy Tarreaue9656522010-08-17 15:40:09 +02009419 Example: accept all connections from white-listed hosts, count all other
9420 connections and reject too fast ones. This results in abusive ones
9421 being blocked as long as they don't slow down.
Willy Tarreau68c03ab2010-08-06 15:08:45 +02009422
Willy Tarreaue9656522010-08-17 15:40:09 +02009423 tcp-request connection accept if { src -f /etc/haproxy/whitelist.lst }
Willy Tarreaube4a3ef2013-06-17 15:04:07 +02009424 tcp-request connection track-sc0 src
9425 tcp-request connection reject if { sc0_conn_rate gt 10 }
Willy Tarreau68c03ab2010-08-06 15:08:45 +02009426
Willy Tarreau4f0d9192013-06-11 20:40:55 +02009427 Example: enable the PROXY protocol for traffic coming from all known proxies.
9428
9429 tcp-request connection expect-proxy layer4 if { src -f proxies.lst }
9430
Willy Tarreau68c03ab2010-08-06 15:08:45 +02009431 See section 7 about ACL usage.
9432
Willy Tarreau4f614292016-10-21 17:49:36 +02009433 See also : "tcp-request session", "tcp-request content", "stick-table"
Willy Tarreau68c03ab2010-08-06 15:08:45 +02009434
9435
Willy Tarreaue9656522010-08-17 15:40:09 +02009436tcp-request content <action> [{if | unless} <condition>]
9437 Perform an action on a new session depending on a layer 4-7 condition
Willy Tarreau62644772008-07-16 18:36:06 +02009438 May be used in sections : defaults | frontend | listen | backend
Willy Tarreaufb356202010-08-03 14:02:05 +02009439 no | yes | yes | yes
Willy Tarreaue9656522010-08-17 15:40:09 +02009440 Arguments :
Willy Tarreauc870bfd2015-09-28 18:47:38 +02009441 <action> defines the action to perform if the condition applies. See
9442 below.
Willy Tarreau62644772008-07-16 18:36:06 +02009443
Willy Tarreaue9656522010-08-17 15:40:09 +02009444 <condition> is a standard layer 4-7 ACL-based condition (see section 7).
Willy Tarreau62644772008-07-16 18:36:06 +02009445
Davor Ocelice9ed2812017-12-25 17:49:28 +01009446 A request's contents can be analyzed at an early stage of request processing
Willy Tarreaue9656522010-08-17 15:40:09 +02009447 called "TCP content inspection". During this stage, ACL-based rules are
9448 evaluated every time the request contents are updated, until either an
9449 "accept" or a "reject" rule matches, or the TCP request inspection delay
9450 expires with no matching rule.
Willy Tarreau62644772008-07-16 18:36:06 +02009451
Willy Tarreaue9656522010-08-17 15:40:09 +02009452 The first difference between these rules and "tcp-request connection" rules
9453 is that "tcp-request content" rules can make use of contents to take a
9454 decision. Most often, these decisions will consider a protocol recognition or
9455 validity. The second difference is that content-based rules can be used in
Willy Tarreauf3338342014-01-28 21:40:28 +01009456 both frontends and backends. In case of HTTP keep-alive with the client, all
9457 tcp-request content rules are evaluated again, so haproxy keeps a record of
9458 what sticky counters were assigned by a "tcp-request connection" versus a
9459 "tcp-request content" rule, and flushes all the content-related ones after
9460 processing an HTTP request, so that they may be evaluated again by the rules
9461 being evaluated again for the next request. This is of particular importance
Jarno Huuskonen0e82b922014-04-12 18:22:19 +03009462 when the rule tracks some L7 information or when it is conditioned by an
Willy Tarreauf3338342014-01-28 21:40:28 +01009463 L7-based ACL, since tracking may change between requests.
Willy Tarreau62644772008-07-16 18:36:06 +02009464
Willy Tarreaue9656522010-08-17 15:40:09 +02009465 Content-based rules are evaluated in their exact declaration order. If no
9466 rule matches or if there is no rule, the default action is to accept the
9467 contents. There is no specific limit to the number of rules which may be
9468 inserted.
Willy Tarreau62644772008-07-16 18:36:06 +02009469
Thierry FOURNIER236657b2015-08-19 08:25:14 +02009470 Several types of actions are supported :
Willy Tarreau18bf01e2014-06-13 16:18:52 +02009471 - accept : the request is accepted
9472 - reject : the request is rejected and the connection is closed
9473 - capture : the specified sample expression is captured
Patrick Hemmer268a7072018-05-11 12:52:31 -04009474 - set-priority-class <expr> | set-priority-offset <expr>
Willy Tarreaube4a3ef2013-06-17 15:04:07 +02009475 - { track-sc0 | track-sc1 | track-sc2 } <key> [table <table>]
Thierry FOURNIERe0627bd2015-08-04 08:20:33 +02009476 - sc-inc-gpc0(<sc-id>)
Frédéric Lécaille6778b272018-01-29 15:22:53 +01009477 - sc-inc-gpc1(<sc-id>)
Thierry Fournierb9125672016-03-29 19:34:37 +02009478 - sc-set-gpt0(<sc-id>) <int>
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02009479 - set-var(<var-name>) <expr>
Christopher Faulet85d79c92016-11-09 16:54:56 +01009480 - unset-var(<var-name>)
Willy Tarreau2d392c22015-08-24 01:43:45 +02009481 - silent-drop
Davor Ocelice9ed2812017-12-25 17:49:28 +01009482 - send-spoe-group <engine-name> <group-name>
Willy Tarreau62644772008-07-16 18:36:06 +02009483
Willy Tarreaue9656522010-08-17 15:40:09 +02009484 They have the same meaning as their counter-parts in "tcp-request connection"
9485 so please refer to that section for a complete description.
Willy Tarreau62644772008-07-16 18:36:06 +02009486
Willy Tarreauf3338342014-01-28 21:40:28 +01009487 While there is nothing mandatory about it, it is recommended to use the
9488 track-sc0 in "tcp-request connection" rules, track-sc1 for "tcp-request
9489 content" rules in the frontend, and track-sc2 for "tcp-request content"
9490 rules in the backend, because that makes the configuration more readable
9491 and easier to troubleshoot, but this is just a guideline and all counters
9492 may be used everywhere.
Willy Tarreau62644772008-07-16 18:36:06 +02009493
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +01009494 Note that the "if/unless" condition is optional. If no condition is set on
Willy Tarreaue9656522010-08-17 15:40:09 +02009495 the action, it is simply performed unconditionally. That can be useful for
9496 "track-sc*" actions as well as for changing the default action to a reject.
Willy Tarreau62644772008-07-16 18:36:06 +02009497
Willy Tarreaue9656522010-08-17 15:40:09 +02009498 It is perfectly possible to match layer 7 contents with "tcp-request content"
Willy Tarreauc0239e02012-04-16 14:42:55 +02009499 rules, since HTTP-specific ACL matches are able to preliminarily parse the
9500 contents of a buffer before extracting the required data. If the buffered
9501 contents do not parse as a valid HTTP message, then the ACL does not match.
9502 The parser which is involved there is exactly the same as for all other HTTP
Willy Tarreauf3338342014-01-28 21:40:28 +01009503 processing, so there is no risk of parsing something differently. In an HTTP
9504 backend connected to from an HTTP frontend, it is guaranteed that HTTP
9505 contents will always be immediately present when the rule is evaluated first.
Willy Tarreau62644772008-07-16 18:36:06 +02009506
Willy Tarreau5d5b5d82012-12-09 12:00:04 +01009507 Tracking layer7 information is also possible provided that the information
Willy Tarreau4d54c7c2014-09-16 15:48:15 +02009508 are present when the rule is processed. The rule processing engine is able to
9509 wait until the inspect delay expires when the data to be tracked is not yet
9510 available.
Willy Tarreau5d5b5d82012-12-09 12:00:04 +01009511
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02009512 The "set-var" is used to set the content of a variable. The variable is
Willy Tarreau4f614292016-10-21 17:49:36 +02009513 declared inline. For "tcp-request session" rules, only session-level
9514 variables can be used, without any layer7 contents.
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02009515
Daniel Schneller0b547052016-03-21 20:46:57 +01009516 <var-name> The name of the variable starts with an indication about
9517 its scope. The scopes allowed are:
Christopher Fauletff2613e2016-11-09 11:36:17 +01009518 "proc" : the variable is shared with the whole process
Daniel Schneller0b547052016-03-21 20:46:57 +01009519 "sess" : the variable is shared with the whole session
9520 "txn" : the variable is shared with the transaction
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02009521 (request and response)
Daniel Schneller0b547052016-03-21 20:46:57 +01009522 "req" : the variable is shared only during request
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02009523 processing
Daniel Schneller0b547052016-03-21 20:46:57 +01009524 "res" : the variable is shared only during response
9525 processing
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02009526 This prefix is followed by a name. The separator is a '.'.
Christopher Fauletb71557a2016-10-31 10:49:03 +01009527 The name may only contain characters 'a-z', 'A-Z', '0-9',
9528 '.' and '_'.
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02009529
9530 <expr> Is a standard HAProxy expression formed by a sample-fetch
9531 followed by some converters.
9532
Christopher Faulet85d79c92016-11-09 16:54:56 +01009533 The "unset-var" is used to unset a variable. See above for details about
9534 <var-name>.
9535
Patrick Hemmer268a7072018-05-11 12:52:31 -04009536 The "set-priority-class" is used to set the queue priority class of the
9537 current request. The value must be a sample expression which converts to an
9538 integer in the range -2047..2047. Results outside this range will be
9539 truncated. The priority class determines the order in which queued requests
9540 are processed. Lower values have higher priority.
9541
9542 The "set-priority-offset" is used to set the queue priority timestamp offset
9543 of the current request. The value must be a sample expression which converts
9544 to an integer in the range -524287..524287. Results outside this range will be
9545 truncated. When a request is queued, it is ordered first by the priority
9546 class, then by the current timestamp adjusted by the given offset in
9547 milliseconds. Lower values have higher priority.
9548 Note that the resulting timestamp is is only tracked with enough precision for
9549 524,287ms (8m44s287ms). If the request is queued long enough to where the
9550 adjusted timestamp exceeds this value, it will be misidentified as highest
9551 priority. Thus it is important to set "timeout queue" to a value, where when
9552 combined with the offset, does not exceed this limit.
9553
Christopher Faulet76c09ef2017-09-21 11:03:52 +02009554 The "send-spoe-group" is used to trigger sending of a group of SPOE
9555 messages. To do so, the SPOE engine used to send messages must be defined, as
9556 well as the SPOE group to send. Of course, the SPOE engine must refer to an
9557 existing SPOE filter. If not engine name is provided on the SPOE filter line,
9558 the SPOE agent name must be used.
9559
9560 <engine-name> The SPOE engine name.
9561
9562 <group-name> The SPOE group name as specified in the engine configuration.
9563
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02009564 Example:
9565
9566 tcp-request content set-var(sess.my_var) src
Christopher Faulet85d79c92016-11-09 16:54:56 +01009567 tcp-request content unset-var(sess.my_var2)
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02009568
Willy Tarreau62644772008-07-16 18:36:06 +02009569 Example:
Willy Tarreaue9656522010-08-17 15:40:09 +02009570 # Accept HTTP requests containing a Host header saying "example.com"
9571 # and reject everything else.
9572 acl is_host_com hdr(Host) -i example.com
9573 tcp-request inspect-delay 30s
Willy Tarreauc0239e02012-04-16 14:42:55 +02009574 tcp-request content accept if is_host_com
Willy Tarreaue9656522010-08-17 15:40:09 +02009575 tcp-request content reject
9576
9577 Example:
Willy Tarreau62644772008-07-16 18:36:06 +02009578 # reject SMTP connection if client speaks first
9579 tcp-request inspect-delay 30s
9580 acl content_present req_len gt 0
Willy Tarreau68c03ab2010-08-06 15:08:45 +02009581 tcp-request content reject if content_present
Willy Tarreau62644772008-07-16 18:36:06 +02009582
9583 # Forward HTTPS connection only if client speaks
9584 tcp-request inspect-delay 30s
9585 acl content_present req_len gt 0
Willy Tarreau68c03ab2010-08-06 15:08:45 +02009586 tcp-request content accept if content_present
Willy Tarreaue9656522010-08-17 15:40:09 +02009587 tcp-request content reject
9588
Willy Tarreau5d5b5d82012-12-09 12:00:04 +01009589 Example:
Jarno Huuskonene5ae7022017-04-03 14:36:21 +03009590 # Track the last IP(stick-table type string) from X-Forwarded-For
Willy Tarreau5d5b5d82012-12-09 12:00:04 +01009591 tcp-request inspect-delay 10s
Willy Tarreau4d54c7c2014-09-16 15:48:15 +02009592 tcp-request content track-sc0 hdr(x-forwarded-for,-1)
Jarno Huuskonene5ae7022017-04-03 14:36:21 +03009593 # Or track the last IP(stick-table type ip|ipv6) from X-Forwarded-For
9594 tcp-request content track-sc0 req.hdr_ip(x-forwarded-for,-1)
Willy Tarreau5d5b5d82012-12-09 12:00:04 +01009595
9596 Example:
9597 # track request counts per "base" (concatenation of Host+URL)
9598 tcp-request inspect-delay 10s
Willy Tarreau4d54c7c2014-09-16 15:48:15 +02009599 tcp-request content track-sc0 base table req-rate
Willy Tarreau5d5b5d82012-12-09 12:00:04 +01009600
Willy Tarreaue9656522010-08-17 15:40:09 +02009601 Example: track per-frontend and per-backend counters, block abusers at the
Jarno Huuskonene5ae7022017-04-03 14:36:21 +03009602 frontend when the backend detects abuse(and marks gpc0).
Willy Tarreaue9656522010-08-17 15:40:09 +02009603
9604 frontend http
Davor Ocelice9ed2812017-12-25 17:49:28 +01009605 # Use General Purpose Counter 0 in SC0 as a global abuse counter
Willy Tarreaue9656522010-08-17 15:40:09 +02009606 # protecting all our sites
9607 stick-table type ip size 1m expire 5m store gpc0
Willy Tarreaube4a3ef2013-06-17 15:04:07 +02009608 tcp-request connection track-sc0 src
9609 tcp-request connection reject if { sc0_get_gpc0 gt 0 }
Willy Tarreaue9656522010-08-17 15:40:09 +02009610 ...
9611 use_backend http_dynamic if { path_end .php }
9612
9613 backend http_dynamic
9614 # if a source makes too fast requests to this dynamic site (tracked
Willy Tarreaube4a3ef2013-06-17 15:04:07 +02009615 # by SC1), block it globally in the frontend.
Willy Tarreaue9656522010-08-17 15:40:09 +02009616 stick-table type ip size 1m expire 5m store http_req_rate(10s)
Willy Tarreaube4a3ef2013-06-17 15:04:07 +02009617 acl click_too_fast sc1_http_req_rate gt 10
Jarno Huuskonene5ae7022017-04-03 14:36:21 +03009618 acl mark_as_abuser sc0_inc_gpc0(http) gt 0
Willy Tarreaube4a3ef2013-06-17 15:04:07 +02009619 tcp-request content track-sc1 src
Willy Tarreaue9656522010-08-17 15:40:09 +02009620 tcp-request content reject if click_too_fast mark_as_abuser
Willy Tarreau62644772008-07-16 18:36:06 +02009621
Willy Tarreauc57f0e22009-05-10 13:12:33 +02009622 See section 7 about ACL usage.
Willy Tarreau62644772008-07-16 18:36:06 +02009623
Jarno Huuskonen95b012b2017-04-06 13:59:14 +03009624 See also : "tcp-request connection", "tcp-request session",
9625 "tcp-request inspect-delay", and "http-request".
Willy Tarreau62644772008-07-16 18:36:06 +02009626
9627
9628tcp-request inspect-delay <timeout>
9629 Set the maximum allowed time to wait for data during content inspection
9630 May be used in sections : defaults | frontend | listen | backend
Willy Tarreaufb356202010-08-03 14:02:05 +02009631 no | yes | yes | yes
Willy Tarreau62644772008-07-16 18:36:06 +02009632 Arguments :
9633 <timeout> is the timeout value specified in milliseconds by default, but
9634 can be in any other unit if the number is suffixed by the unit,
9635 as explained at the top of this document.
9636
9637 People using haproxy primarily as a TCP relay are often worried about the
9638 risk of passing any type of protocol to a server without any analysis. In
9639 order to be able to analyze the request contents, we must first withhold
9640 the data then analyze them. This statement simply enables withholding of
9641 data for at most the specified amount of time.
9642
Willy Tarreaufb356202010-08-03 14:02:05 +02009643 TCP content inspection applies very early when a connection reaches a
9644 frontend, then very early when the connection is forwarded to a backend. This
9645 means that a connection may experience a first delay in the frontend and a
9646 second delay in the backend if both have tcp-request rules.
9647
Willy Tarreau62644772008-07-16 18:36:06 +02009648 Note that when performing content inspection, haproxy will evaluate the whole
9649 rules for every new chunk which gets in, taking into account the fact that
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +01009650 those data are partial. If no rule matches before the aforementioned delay,
Willy Tarreau62644772008-07-16 18:36:06 +02009651 a last check is performed upon expiration, this time considering that the
Willy Tarreaud869b242009-03-15 14:43:58 +01009652 contents are definitive. If no delay is set, haproxy will not wait at all
9653 and will immediately apply a verdict based on the available information.
9654 Obviously this is unlikely to be very useful and might even be racy, so such
9655 setups are not recommended.
Willy Tarreau62644772008-07-16 18:36:06 +02009656
9657 As soon as a rule matches, the request is released and continues as usual. If
9658 the timeout is reached and no rule matches, the default policy will be to let
9659 it pass through unaffected.
9660
9661 For most protocols, it is enough to set it to a few seconds, as most clients
9662 send the full request immediately upon connection. Add 3 or more seconds to
9663 cover TCP retransmits but that's all. For some protocols, it may make sense
Willy Tarreaud72758d2010-01-12 10:42:19 +01009664 to use large values, for instance to ensure that the client never talks
Davor Ocelice9ed2812017-12-25 17:49:28 +01009665 before the server (e.g. SMTP), or to wait for a client to talk before passing
9666 data to the server (e.g. SSL). Note that the client timeout must cover at
Willy Tarreaub824b002010-09-29 16:36:16 +02009667 least the inspection delay, otherwise it will expire first. If the client
9668 closes the connection or if the buffer is full, the delay immediately expires
9669 since the contents will not be able to change anymore.
Willy Tarreau62644772008-07-16 18:36:06 +02009670
Willy Tarreau55165fe2009-05-10 12:02:55 +02009671 See also : "tcp-request content accept", "tcp-request content reject",
Willy Tarreau62644772008-07-16 18:36:06 +02009672 "timeout client".
9673
9674
Emeric Brun0a3b67f2010-09-24 15:34:53 +02009675tcp-response content <action> [{if | unless} <condition>]
9676 Perform an action on a session response depending on a layer 4-7 condition
9677 May be used in sections : defaults | frontend | listen | backend
9678 no | no | yes | yes
9679 Arguments :
Willy Tarreauc870bfd2015-09-28 18:47:38 +02009680 <action> defines the action to perform if the condition applies. See
9681 below.
Emeric Brun0a3b67f2010-09-24 15:34:53 +02009682
9683 <condition> is a standard layer 4-7 ACL-based condition (see section 7).
9684
Davor Ocelice9ed2812017-12-25 17:49:28 +01009685 Response contents can be analyzed at an early stage of response processing
Emeric Brun0a3b67f2010-09-24 15:34:53 +02009686 called "TCP content inspection". During this stage, ACL-based rules are
9687 evaluated every time the response contents are updated, until either an
Willy Tarreaucc1e04b2013-09-11 23:20:29 +02009688 "accept", "close" or a "reject" rule matches, or a TCP response inspection
9689 delay is set and expires with no matching rule.
Emeric Brun0a3b67f2010-09-24 15:34:53 +02009690
9691 Most often, these decisions will consider a protocol recognition or validity.
9692
9693 Content-based rules are evaluated in their exact declaration order. If no
9694 rule matches or if there is no rule, the default action is to accept the
9695 contents. There is no specific limit to the number of rules which may be
9696 inserted.
9697
Thierry FOURNIER236657b2015-08-19 08:25:14 +02009698 Several types of actions are supported :
Emeric Brun0a3b67f2010-09-24 15:34:53 +02009699 - accept :
9700 accepts the response if the condition is true (when used with "if")
9701 or false (when used with "unless"). The first such rule executed ends
9702 the rules evaluation.
9703
Willy Tarreaucc1e04b2013-09-11 23:20:29 +02009704 - close :
9705 immediately closes the connection with the server if the condition is
9706 true (when used with "if"), or false (when used with "unless"). The
9707 first such rule executed ends the rules evaluation. The main purpose of
9708 this action is to force a connection to be finished between a client
9709 and a server after an exchange when the application protocol expects
9710 some long time outs to elapse first. The goal is to eliminate idle
Jarno Huuskonen0e82b922014-04-12 18:22:19 +03009711 connections which take significant resources on servers with certain
Willy Tarreaucc1e04b2013-09-11 23:20:29 +02009712 protocols.
9713
Emeric Brun0a3b67f2010-09-24 15:34:53 +02009714 - reject :
9715 rejects the response if the condition is true (when used with "if")
9716 or false (when used with "unless"). The first such rule executed ends
Jamie Gloudonaaa21002012-08-25 00:18:33 -04009717 the rules evaluation. Rejected session are immediately closed.
Emeric Brun0a3b67f2010-09-24 15:34:53 +02009718
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02009719 - set-var(<var-name>) <expr>
9720 Sets a variable.
9721
Christopher Faulet85d79c92016-11-09 16:54:56 +01009722 - unset-var(<var-name>)
9723 Unsets a variable.
9724
Thierry FOURNIERe0627bd2015-08-04 08:20:33 +02009725 - sc-inc-gpc0(<sc-id>):
9726 This action increments the GPC0 counter according to the sticky
9727 counter designated by <sc-id>. If an error occurs, this action fails
9728 silently and the actions evaluation continues.
9729
Frédéric Lécaille6778b272018-01-29 15:22:53 +01009730 - sc-inc-gpc1(<sc-id>):
9731 This action increments the GPC1 counter according to the sticky
9732 counter designated by <sc-id>. If an error occurs, this action fails
9733 silently and the actions evaluation continues.
9734
Thierry FOURNIER236657b2015-08-19 08:25:14 +02009735 - sc-set-gpt0(<sc-id>) <int> :
9736 This action sets the GPT0 tag according to the sticky counter designated
9737 by <sc-id> and the value of <int>. The expected result is a boolean. If
9738 an error occurs, this action silently fails and the actions evaluation
9739 continues.
9740
Willy Tarreau2d392c22015-08-24 01:43:45 +02009741 - "silent-drop" :
9742 This stops the evaluation of the rules and makes the client-facing
Davor Ocelice9ed2812017-12-25 17:49:28 +01009743 connection suddenly disappear using a system-dependent way that tries
Willy Tarreau2d392c22015-08-24 01:43:45 +02009744 to prevent the client from being notified. The effect it then that the
9745 client still sees an established connection while there's none on
9746 HAProxy. The purpose is to achieve a comparable effect to "tarpit"
9747 except that it doesn't use any local resource at all on the machine
9748 running HAProxy. It can resist much higher loads than "tarpit", and
Davor Ocelice9ed2812017-12-25 17:49:28 +01009749 slow down stronger attackers. It is important to understand the impact
9750 of using this mechanism. All stateful equipment placed between the
Willy Tarreau2d392c22015-08-24 01:43:45 +02009751 client and HAProxy (firewalls, proxies, load balancers) will also keep
9752 the established connection for a long time and may suffer from this
Davor Ocelice9ed2812017-12-25 17:49:28 +01009753 action. On modern Linux systems running with enough privileges, the
Willy Tarreau2d392c22015-08-24 01:43:45 +02009754 TCP_REPAIR socket option is used to block the emission of a TCP
9755 reset. On other systems, the socket's TTL is reduced to 1 so that the
9756 TCP reset doesn't pass the first router, though it's still delivered to
9757 local networks. Do not use it unless you fully understand how it works.
9758
Christopher Faulet76c09ef2017-09-21 11:03:52 +02009759 - send-spoe-group <engine-name> <group-name>
9760 Send a group of SPOE messages.
9761
Emeric Brun0a3b67f2010-09-24 15:34:53 +02009762 Note that the "if/unless" condition is optional. If no condition is set on
9763 the action, it is simply performed unconditionally. That can be useful for
9764 for changing the default action to a reject.
9765
Jamie Gloudonaaa21002012-08-25 00:18:33 -04009766 It is perfectly possible to match layer 7 contents with "tcp-response
9767 content" rules, but then it is important to ensure that a full response has
9768 been buffered, otherwise no contents will match. In order to achieve this,
9769 the best solution involves detecting the HTTP protocol during the inspection
Emeric Brun0a3b67f2010-09-24 15:34:53 +02009770 period.
9771
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02009772 The "set-var" is used to set the content of a variable. The variable is
9773 declared inline.
9774
Daniel Schneller0b547052016-03-21 20:46:57 +01009775 <var-name> The name of the variable starts with an indication about
9776 its scope. The scopes allowed are:
Christopher Fauletff2613e2016-11-09 11:36:17 +01009777 "proc" : the variable is shared with the whole process
Daniel Schneller0b547052016-03-21 20:46:57 +01009778 "sess" : the variable is shared with the whole session
9779 "txn" : the variable is shared with the transaction
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02009780 (request and response)
Daniel Schneller0b547052016-03-21 20:46:57 +01009781 "req" : the variable is shared only during request
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02009782 processing
Daniel Schneller0b547052016-03-21 20:46:57 +01009783 "res" : the variable is shared only during response
9784 processing
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02009785 This prefix is followed by a name. The separator is a '.'.
Christopher Fauletb71557a2016-10-31 10:49:03 +01009786 The name may only contain characters 'a-z', 'A-Z', '0-9',
9787 '.' and '_'.
Thierry FOURNIER4834bc72015-06-06 19:29:07 +02009788
9789 <expr> Is a standard HAProxy expression formed by a sample-fetch
9790 followed by some converters.
9791
9792 Example:
9793
9794 tcp-request content set-var(sess.my_var) src
9795
Christopher Faulet85d79c92016-11-09 16:54:56 +01009796 The "unset-var" is used to unset a variable. See above for details about
9797 <var-name>.
9798
9799 Example:
9800
9801 tcp-request content unset-var(sess.my_var)
9802
Christopher Faulet76c09ef2017-09-21 11:03:52 +02009803 The "send-spoe-group" is used to trigger sending of a group of SPOE
9804 messages. To do so, the SPOE engine used to send messages must be defined, as
9805 well as the SPOE group to send. Of course, the SPOE engine must refer to an
9806 existing SPOE filter. If not engine name is provided on the SPOE filter line,
9807 the SPOE agent name must be used.
9808
9809 <engine-name> The SPOE engine name.
9810
9811 <group-name> The SPOE group name as specified in the engine configuration.
9812
Emeric Brun0a3b67f2010-09-24 15:34:53 +02009813 See section 7 about ACL usage.
9814
9815 See also : "tcp-request content", "tcp-response inspect-delay"
9816
9817
Willy Tarreau4f614292016-10-21 17:49:36 +02009818tcp-request session <action> [{if | unless} <condition>]
9819 Perform an action on a validated session depending on a layer 5 condition
9820 May be used in sections : defaults | frontend | listen | backend
9821 no | yes | yes | no
9822 Arguments :
9823 <action> defines the action to perform if the condition applies. See
9824 below.
9825
9826 <condition> is a standard layer5-only ACL-based condition (see section 7).
9827
Davor Ocelice9ed2812017-12-25 17:49:28 +01009828 Once a session is validated, (i.e. after all handshakes have been completed),
Willy Tarreau4f614292016-10-21 17:49:36 +02009829 it is possible to evaluate some conditions to decide whether this session
9830 must be accepted or dropped or have its counters tracked. Those conditions
9831 cannot make use of any data contents because no buffers are allocated yet and
9832 the processing cannot wait at this stage. The main use case it to copy some
9833 early information into variables (since variables are accessible in the
9834 session), or to keep track of some information collected after the handshake,
9835 such as SSL-level elements (SNI, ciphers, client cert's CN) or information
Davor Ocelice9ed2812017-12-25 17:49:28 +01009836 from the PROXY protocol header (e.g. track a source forwarded this way). The
Willy Tarreau4f614292016-10-21 17:49:36 +02009837 extracted information can thus be copied to a variable or tracked using
9838 "track-sc" rules. Of course it is also possible to decide to accept/reject as
9839 with other rulesets. Most operations performed here could also be performed
9840 in "tcp-request content" rules, except that in HTTP these rules are evaluated
9841 for each new request, and that might not always be acceptable. For example a
9842 rule might increment a counter on each evaluation. It would also be possible
9843 that a country is resolved by geolocation from the source IP address,
9844 assigned to a session-wide variable, then the source address rewritten from
9845 an HTTP header for all requests. If some contents need to be inspected in
9846 order to take the decision, the "tcp-request content" statements must be used
9847 instead.
9848
9849 The "tcp-request session" rules are evaluated in their exact declaration
9850 order. If no rule matches or if there is no rule, the default action is to
9851 accept the incoming session. There is no specific limit to the number of
9852 rules which may be inserted.
9853
9854 Several types of actions are supported :
9855 - accept : the request is accepted
9856 - reject : the request is rejected and the connection is closed
9857 - { track-sc0 | track-sc1 | track-sc2 } <key> [table <table>]
9858 - sc-inc-gpc0(<sc-id>)
Frédéric Lécaille6778b272018-01-29 15:22:53 +01009859 - sc-inc-gpc1(<sc-id>)
Willy Tarreau4f614292016-10-21 17:49:36 +02009860 - sc-set-gpt0(<sc-id>) <int>
9861 - set-var(<var-name>) <expr>
Christopher Faulet85d79c92016-11-09 16:54:56 +01009862 - unset-var(<var-name>)
Willy Tarreau4f614292016-10-21 17:49:36 +02009863 - silent-drop
9864
9865 These actions have the same meaning as their respective counter-parts in
9866 "tcp-request connection" and "tcp-request content", so please refer to these
9867 sections for a complete description.
9868
9869 Note that the "if/unless" condition is optional. If no condition is set on
9870 the action, it is simply performed unconditionally. That can be useful for
9871 "track-sc*" actions as well as for changing the default action to a reject.
9872
9873 Example: track the original source address by default, or the one advertised
9874 in the PROXY protocol header for connection coming from the local
9875 proxies. The first connection-level rule enables receipt of the
9876 PROXY protocol for these ones, the second rule tracks whatever
9877 address we decide to keep after optional decoding.
9878
9879 tcp-request connection expect-proxy layer4 if { src -f proxies.lst }
9880 tcp-request session track-sc0 src
9881
9882 Example: accept all sessions from white-listed hosts, reject too fast
9883 sessions without counting them, and track accepted sessions.
9884 This results in session rate being capped from abusive sources.
9885
9886 tcp-request session accept if { src -f /etc/haproxy/whitelist.lst }
9887 tcp-request session reject if { src_sess_rate gt 10 }
9888 tcp-request session track-sc0 src
9889
9890 Example: accept all sessions from white-listed hosts, count all other
9891 sessions and reject too fast ones. This results in abusive ones
9892 being blocked as long as they don't slow down.
9893
9894 tcp-request session accept if { src -f /etc/haproxy/whitelist.lst }
9895 tcp-request session track-sc0 src
9896 tcp-request session reject if { sc0_sess_rate gt 10 }
9897
9898 See section 7 about ACL usage.
9899
9900 See also : "tcp-request connection", "tcp-request content", "stick-table"
9901
9902
Emeric Brun0a3b67f2010-09-24 15:34:53 +02009903tcp-response inspect-delay <timeout>
9904 Set the maximum allowed time to wait for a response during content inspection
9905 May be used in sections : defaults | frontend | listen | backend
9906 no | no | yes | yes
9907 Arguments :
9908 <timeout> is the timeout value specified in milliseconds by default, but
9909 can be in any other unit if the number is suffixed by the unit,
9910 as explained at the top of this document.
9911
9912 See also : "tcp-response content", "tcp-request inspect-delay".
9913
9914
Krzysztof Piotr Oledzki5259dfe2008-01-21 01:54:06 +01009915timeout check <timeout>
9916 Set additional check timeout, but only after a connection has been already
9917 established.
9918
9919 May be used in sections: defaults | frontend | listen | backend
9920 yes | no | yes | yes
9921 Arguments:
9922 <timeout> is the timeout value specified in milliseconds by default, but
9923 can be in any other unit if the number is suffixed by the unit,
9924 as explained at the top of this document.
9925
9926 If set, haproxy uses min("timeout connect", "inter") as a connect timeout
9927 for check and "timeout check" as an additional read timeout. The "min" is
Davor Ocelice9ed2812017-12-25 17:49:28 +01009928 used so that people running with *very* long "timeout connect" (e.g. those
Krzysztof Piotr Oledzki5259dfe2008-01-21 01:54:06 +01009929 who needed this due to the queue or tarpit) do not slow down their checks.
Willy Tarreaud7550a22010-02-10 05:10:19 +01009930 (Please also note that there is no valid reason to have such long connect
9931 timeouts, because "timeout queue" and "timeout tarpit" can always be used to
9932 avoid that).
Krzysztof Piotr Oledzki5259dfe2008-01-21 01:54:06 +01009933
9934 If "timeout check" is not set haproxy uses "inter" for complete check
9935 timeout (connect + read) exactly like all <1.3.15 version.
9936
9937 In most cases check request is much simpler and faster to handle than normal
9938 requests and people may want to kick out laggy servers so this timeout should
Willy Tarreau41a340d2008-01-22 12:25:31 +01009939 be smaller than "timeout server".
Krzysztof Piotr Oledzki5259dfe2008-01-21 01:54:06 +01009940
9941 This parameter is specific to backends, but can be specified once for all in
9942 "defaults" sections. This is in fact one of the easiest solutions not to
9943 forget about it.
9944
Willy Tarreau41a340d2008-01-22 12:25:31 +01009945 See also: "timeout connect", "timeout queue", "timeout server",
9946 "timeout tarpit".
Krzysztof Piotr Oledzki5259dfe2008-01-21 01:54:06 +01009947
9948
Willy Tarreau0ba27502007-12-24 16:55:16 +01009949timeout client <timeout>
9950timeout clitimeout <timeout> (deprecated)
9951 Set the maximum inactivity time on the client side.
9952 May be used in sections : defaults | frontend | listen | backend
9953 yes | yes | yes | no
9954 Arguments :
Willy Tarreau844e3c52008-01-11 16:28:18 +01009955 <timeout> is the timeout value specified in milliseconds by default, but
Willy Tarreau0ba27502007-12-24 16:55:16 +01009956 can be in any other unit if the number is suffixed by the unit,
9957 as explained at the top of this document.
9958
9959 The inactivity timeout applies when the client is expected to acknowledge or
9960 send data. In HTTP mode, this timeout is particularly important to consider
9961 during the first phase, when the client sends the request, and during the
Baptiste Assmann2e1941e2016-03-06 23:24:12 +01009962 response while it is reading data sent by the server. That said, for the
9963 first phase, it is preferable to set the "timeout http-request" to better
9964 protect HAProxy from Slowloris like attacks. The value is specified in
9965 milliseconds by default, but can be in any other unit if the number is
Willy Tarreau0ba27502007-12-24 16:55:16 +01009966 suffixed by the unit, as specified at the top of this document. In TCP mode
9967 (and to a lesser extent, in HTTP mode), it is highly recommended that the
9968 client timeout remains equal to the server timeout in order to avoid complex
Willy Tarreaud2a4aa22008-01-31 15:28:22 +01009969 situations to debug. It is a good practice to cover one or several TCP packet
Willy Tarreau0ba27502007-12-24 16:55:16 +01009970 losses by specifying timeouts that are slightly above multiples of 3 seconds
Davor Ocelice9ed2812017-12-25 17:49:28 +01009971 (e.g. 4 or 5 seconds). If some long-lived sessions are mixed with short-lived
9972 sessions (e.g. WebSocket and HTTP), it's worth considering "timeout tunnel",
Willy Tarreau05cdd962014-05-10 14:30:07 +02009973 which overrides "timeout client" and "timeout server" for tunnels, as well as
9974 "timeout client-fin" for half-closed connections.
Willy Tarreau0ba27502007-12-24 16:55:16 +01009975
9976 This parameter is specific to frontends, but can be specified once for all in
9977 "defaults" sections. This is in fact one of the easiest solutions not to
9978 forget about it. An unspecified timeout results in an infinite timeout, which
9979 is not recommended. Such a usage is accepted and works but reports a warning
9980 during startup because it may results in accumulation of expired sessions in
9981 the system if the system's timeouts are not configured either.
9982
Willy Tarreau95c4e142017-11-26 12:18:55 +01009983 This also applies to HTTP/2 connections, which will be closed with GOAWAY.
Lukas Tribus75df9d72017-11-24 19:05:12 +01009984
Willy Tarreau0ba27502007-12-24 16:55:16 +01009985 This parameter replaces the old, deprecated "clitimeout". It is recommended
9986 to use it to write new configurations. The form "timeout clitimeout" is
9987 provided only by backwards compatibility but its use is strongly discouraged.
9988
Baptiste Assmann2e1941e2016-03-06 23:24:12 +01009989 See also : "clitimeout", "timeout server", "timeout tunnel",
9990 "timeout http-request".
Willy Tarreau0ba27502007-12-24 16:55:16 +01009991
9992
Willy Tarreau05cdd962014-05-10 14:30:07 +02009993timeout client-fin <timeout>
9994 Set the inactivity timeout on the client side for half-closed connections.
9995 May be used in sections : defaults | frontend | listen | backend
9996 yes | yes | yes | no
9997 Arguments :
9998 <timeout> is the timeout value specified in milliseconds by default, but
9999 can be in any other unit if the number is suffixed by the unit,
10000 as explained at the top of this document.
10001
10002 The inactivity timeout applies when the client is expected to acknowledge or
10003 send data while one direction is already shut down. This timeout is different
10004 from "timeout client" in that it only applies to connections which are closed
10005 in one direction. This is particularly useful to avoid keeping connections in
10006 FIN_WAIT state for too long when clients do not disconnect cleanly. This
10007 problem is particularly common long connections such as RDP or WebSocket.
10008 Note that this timeout can override "timeout tunnel" when a connection shuts
Willy Tarreau599391a2017-11-24 10:16:00 +010010009 down in one direction. It is applied to idle HTTP/2 connections once a GOAWAY
10010 frame was sent, often indicating an expectation that the connection quickly
10011 ends.
Willy Tarreau05cdd962014-05-10 14:30:07 +020010012
10013 This parameter is specific to frontends, but can be specified once for all in
10014 "defaults" sections. By default it is not set, so half-closed connections
10015 will use the other timeouts (timeout.client or timeout.tunnel).
10016
10017 See also : "timeout client", "timeout server-fin", and "timeout tunnel".
10018
10019
Willy Tarreau0ba27502007-12-24 16:55:16 +010010020timeout connect <timeout>
10021timeout contimeout <timeout> (deprecated)
10022 Set the maximum time to wait for a connection attempt to a server to succeed.
10023 May be used in sections : defaults | frontend | listen | backend
10024 yes | no | yes | yes
10025 Arguments :
Willy Tarreau844e3c52008-01-11 16:28:18 +010010026 <timeout> is the timeout value specified in milliseconds by default, but
Willy Tarreau0ba27502007-12-24 16:55:16 +010010027 can be in any other unit if the number is suffixed by the unit,
10028 as explained at the top of this document.
10029
10030 If the server is located on the same LAN as haproxy, the connection should be
Willy Tarreaud2a4aa22008-01-31 15:28:22 +010010031 immediate (less than a few milliseconds). Anyway, it is a good practice to
Willy Tarreaud72758d2010-01-12 10:42:19 +010010032 cover one or several TCP packet losses by specifying timeouts that are
Davor Ocelice9ed2812017-12-25 17:49:28 +010010033 slightly above multiples of 3 seconds (e.g. 4 or 5 seconds). By default, the
Krzysztof Piotr Oledzki5259dfe2008-01-21 01:54:06 +010010034 connect timeout also presets both queue and tarpit timeouts to the same value
10035 if these have not been specified.
Willy Tarreau0ba27502007-12-24 16:55:16 +010010036
10037 This parameter is specific to backends, but can be specified once for all in
10038 "defaults" sections. This is in fact one of the easiest solutions not to
10039 forget about it. An unspecified timeout results in an infinite timeout, which
10040 is not recommended. Such a usage is accepted and works but reports a warning
10041 during startup because it may results in accumulation of failed sessions in
10042 the system if the system's timeouts are not configured either.
10043
10044 This parameter replaces the old, deprecated "contimeout". It is recommended
10045 to use it to write new configurations. The form "timeout contimeout" is
10046 provided only by backwards compatibility but its use is strongly discouraged.
10047
Willy Tarreau41a340d2008-01-22 12:25:31 +010010048 See also: "timeout check", "timeout queue", "timeout server", "contimeout",
10049 "timeout tarpit".
Willy Tarreau0ba27502007-12-24 16:55:16 +010010050
10051
Willy Tarreaub16a5742010-01-10 14:46:16 +010010052timeout http-keep-alive <timeout>
10053 Set the maximum allowed time to wait for a new HTTP request to appear
10054 May be used in sections : defaults | frontend | listen | backend
10055 yes | yes | yes | yes
10056 Arguments :
10057 <timeout> is the timeout value specified in milliseconds by default, but
10058 can be in any other unit if the number is suffixed by the unit,
10059 as explained at the top of this document.
10060
10061 By default, the time to wait for a new request in case of keep-alive is set
10062 by "timeout http-request". However this is not always convenient because some
10063 people want very short keep-alive timeouts in order to release connections
10064 faster, and others prefer to have larger ones but still have short timeouts
10065 once the request has started to present itself.
10066
10067 The "http-keep-alive" timeout covers these needs. It will define how long to
10068 wait for a new HTTP request to start coming after a response was sent. Once
10069 the first byte of request has been seen, the "http-request" timeout is used
10070 to wait for the complete request to come. Note that empty lines prior to a
10071 new request do not refresh the timeout and are not counted as a new request.
10072
10073 There is also another difference between the two timeouts : when a connection
10074 expires during timeout http-keep-alive, no error is returned, the connection
10075 just closes. If the connection expires in "http-request" while waiting for a
10076 connection to complete, a HTTP 408 error is returned.
10077
10078 In general it is optimal to set this value to a few tens to hundreds of
10079 milliseconds, to allow users to fetch all objects of a page at once but
Davor Ocelice9ed2812017-12-25 17:49:28 +010010080 without waiting for further clicks. Also, if set to a very small value (e.g.
Willy Tarreaub16a5742010-01-10 14:46:16 +010010081 1 millisecond) it will probably only accept pipelined requests but not the
10082 non-pipelined ones. It may be a nice trade-off for very large sites running
Patrick Mézard2382ad62010-05-09 10:43:32 +020010083 with tens to hundreds of thousands of clients.
Willy Tarreaub16a5742010-01-10 14:46:16 +010010084
10085 If this parameter is not set, the "http-request" timeout applies, and if both
10086 are not set, "timeout client" still applies at the lower level. It should be
10087 set in the frontend to take effect, unless the frontend is in TCP mode, in
10088 which case the HTTP backend's timeout will be used.
10089
Willy Tarreau95c4e142017-11-26 12:18:55 +010010090 When using HTTP/2 "timeout client" is applied instead. This is so we can keep
10091 using short keep-alive timeouts in HTTP/1.1 while using longer ones in HTTP/2
Lukas Tribus75df9d72017-11-24 19:05:12 +010010092 (where we only have one connection per client and a connection setup).
10093
Willy Tarreaub16a5742010-01-10 14:46:16 +010010094 See also : "timeout http-request", "timeout client".
10095
10096
Willy Tarreau036fae02008-01-06 13:24:40 +010010097timeout http-request <timeout>
10098 Set the maximum allowed time to wait for a complete HTTP request
10099 May be used in sections : defaults | frontend | listen | backend
Willy Tarreaucd7afc02009-07-12 10:03:17 +020010100 yes | yes | yes | yes
Willy Tarreau036fae02008-01-06 13:24:40 +010010101 Arguments :
Willy Tarreau844e3c52008-01-11 16:28:18 +010010102 <timeout> is the timeout value specified in milliseconds by default, but
Willy Tarreau036fae02008-01-06 13:24:40 +010010103 can be in any other unit if the number is suffixed by the unit,
10104 as explained at the top of this document.
10105
10106 In order to offer DoS protection, it may be required to lower the maximum
10107 accepted time to receive a complete HTTP request without affecting the client
10108 timeout. This helps protecting against established connections on which
10109 nothing is sent. The client timeout cannot offer a good protection against
10110 this abuse because it is an inactivity timeout, which means that if the
10111 attacker sends one character every now and then, the timeout will not
10112 trigger. With the HTTP request timeout, no matter what speed the client
Willy Tarreau2705a612014-05-23 17:38:34 +020010113 types, the request will be aborted if it does not complete in time. When the
10114 timeout expires, an HTTP 408 response is sent to the client to inform it
10115 about the problem, and the connection is closed. The logs will report
10116 termination codes "cR". Some recent browsers are having problems with this
Davor Ocelice9ed2812017-12-25 17:49:28 +010010117 standard, well-documented behavior, so it might be needed to hide the 408
Willy Tarreau0f228a02015-05-01 15:37:53 +020010118 code using "option http-ignore-probes" or "errorfile 408 /dev/null". See
10119 more details in the explanations of the "cR" termination code in section 8.5.
Willy Tarreau036fae02008-01-06 13:24:40 +010010120
Baptiste Assmanneccdf432015-10-28 13:49:01 +010010121 By default, this timeout only applies to the header part of the request,
10122 and not to any data. As soon as the empty line is received, this timeout is
10123 not used anymore. When combined with "option http-buffer-request", this
10124 timeout also applies to the body of the request..
10125 It is used again on keep-alive connections to wait for a second
Willy Tarreaub16a5742010-01-10 14:46:16 +010010126 request if "timeout http-keep-alive" is not set.
Willy Tarreau036fae02008-01-06 13:24:40 +010010127
10128 Generally it is enough to set it to a few seconds, as most clients send the
10129 full request immediately upon connection. Add 3 or more seconds to cover TCP
Davor Ocelice9ed2812017-12-25 17:49:28 +010010130 retransmits but that's all. Setting it to very low values (e.g. 50 ms) will
Willy Tarreau036fae02008-01-06 13:24:40 +010010131 generally work on local networks as long as there are no packet losses. This
10132 will prevent people from sending bare HTTP requests using telnet.
10133
10134 If this parameter is not set, the client timeout still applies between each
Willy Tarreaucd7afc02009-07-12 10:03:17 +020010135 chunk of the incoming request. It should be set in the frontend to take
10136 effect, unless the frontend is in TCP mode, in which case the HTTP backend's
10137 timeout will be used.
Willy Tarreau036fae02008-01-06 13:24:40 +010010138
Willy Tarreau0f228a02015-05-01 15:37:53 +020010139 See also : "errorfile", "http-ignore-probes", "timeout http-keep-alive", and
Baptiste Assmanneccdf432015-10-28 13:49:01 +010010140 "timeout client", "option http-buffer-request".
Willy Tarreau036fae02008-01-06 13:24:40 +010010141
Willy Tarreau844e3c52008-01-11 16:28:18 +010010142
10143timeout queue <timeout>
10144 Set the maximum time to wait in the queue for a connection slot to be free
10145 May be used in sections : defaults | frontend | listen | backend
10146 yes | no | yes | yes
10147 Arguments :
10148 <timeout> is the timeout value specified in milliseconds by default, but
10149 can be in any other unit if the number is suffixed by the unit,
10150 as explained at the top of this document.
10151
10152 When a server's maxconn is reached, connections are left pending in a queue
10153 which may be server-specific or global to the backend. In order not to wait
10154 indefinitely, a timeout is applied to requests pending in the queue. If the
10155 timeout is reached, it is considered that the request will almost never be
10156 served, so it is dropped and a 503 error is returned to the client.
10157
10158 The "timeout queue" statement allows to fix the maximum time for a request to
10159 be left pending in a queue. If unspecified, the same value as the backend's
10160 connection timeout ("timeout connect") is used, for backwards compatibility
10161 with older versions with no "timeout queue" parameter.
10162
10163 See also : "timeout connect", "contimeout".
10164
10165
10166timeout server <timeout>
10167timeout srvtimeout <timeout> (deprecated)
10168 Set the maximum inactivity time on the server side.
10169 May be used in sections : defaults | frontend | listen | backend
10170 yes | no | yes | yes
10171 Arguments :
10172 <timeout> is the timeout value specified in milliseconds by default, but
10173 can be in any other unit if the number is suffixed by the unit,
10174 as explained at the top of this document.
10175
10176 The inactivity timeout applies when the server is expected to acknowledge or
10177 send data. In HTTP mode, this timeout is particularly important to consider
10178 during the first phase of the server's response, when it has to send the
10179 headers, as it directly represents the server's processing time for the
10180 request. To find out what value to put there, it's often good to start with
10181 what would be considered as unacceptable response times, then check the logs
10182 to observe the response time distribution, and adjust the value accordingly.
10183
10184 The value is specified in milliseconds by default, but can be in any other
10185 unit if the number is suffixed by the unit, as specified at the top of this
10186 document. In TCP mode (and to a lesser extent, in HTTP mode), it is highly
10187 recommended that the client timeout remains equal to the server timeout in
10188 order to avoid complex situations to debug. Whatever the expected server
Willy Tarreaud2a4aa22008-01-31 15:28:22 +010010189 response times, it is a good practice to cover at least one or several TCP
Willy Tarreau844e3c52008-01-11 16:28:18 +010010190 packet losses by specifying timeouts that are slightly above multiples of 3
Davor Ocelice9ed2812017-12-25 17:49:28 +010010191 seconds (e.g. 4 or 5 seconds minimum). If some long-lived sessions are mixed
10192 with short-lived sessions (e.g. WebSocket and HTTP), it's worth considering
Willy Tarreauce887fd2012-05-12 12:50:00 +020010193 "timeout tunnel", which overrides "timeout client" and "timeout server" for
10194 tunnels.
Willy Tarreau844e3c52008-01-11 16:28:18 +010010195
10196 This parameter is specific to backends, but can be specified once for all in
10197 "defaults" sections. This is in fact one of the easiest solutions not to
10198 forget about it. An unspecified timeout results in an infinite timeout, which
10199 is not recommended. Such a usage is accepted and works but reports a warning
10200 during startup because it may results in accumulation of expired sessions in
10201 the system if the system's timeouts are not configured either.
10202
10203 This parameter replaces the old, deprecated "srvtimeout". It is recommended
10204 to use it to write new configurations. The form "timeout srvtimeout" is
10205 provided only by backwards compatibility but its use is strongly discouraged.
10206
Willy Tarreauce887fd2012-05-12 12:50:00 +020010207 See also : "srvtimeout", "timeout client" and "timeout tunnel".
Willy Tarreau844e3c52008-01-11 16:28:18 +010010208
Willy Tarreau05cdd962014-05-10 14:30:07 +020010209
10210timeout server-fin <timeout>
10211 Set the inactivity timeout on the server side for half-closed connections.
10212 May be used in sections : defaults | frontend | listen | backend
10213 yes | no | yes | yes
10214 Arguments :
10215 <timeout> is the timeout value specified in milliseconds by default, but
10216 can be in any other unit if the number is suffixed by the unit,
10217 as explained at the top of this document.
10218
10219 The inactivity timeout applies when the server is expected to acknowledge or
10220 send data while one direction is already shut down. This timeout is different
10221 from "timeout server" in that it only applies to connections which are closed
10222 in one direction. This is particularly useful to avoid keeping connections in
10223 FIN_WAIT state for too long when a remote server does not disconnect cleanly.
10224 This problem is particularly common long connections such as RDP or WebSocket.
10225 Note that this timeout can override "timeout tunnel" when a connection shuts
10226 down in one direction. This setting was provided for completeness, but in most
10227 situations, it should not be needed.
10228
10229 This parameter is specific to backends, but can be specified once for all in
10230 "defaults" sections. By default it is not set, so half-closed connections
10231 will use the other timeouts (timeout.server or timeout.tunnel).
10232
10233 See also : "timeout client-fin", "timeout server", and "timeout tunnel".
10234
Willy Tarreau844e3c52008-01-11 16:28:18 +010010235
10236timeout tarpit <timeout>
Cyril Bonté78caf842010-03-10 22:41:43 +010010237 Set the duration for which tarpitted connections will be maintained
Willy Tarreau844e3c52008-01-11 16:28:18 +010010238 May be used in sections : defaults | frontend | listen | backend
10239 yes | yes | yes | yes
10240 Arguments :
10241 <timeout> is the tarpit duration specified in milliseconds by default, but
10242 can be in any other unit if the number is suffixed by the unit,
10243 as explained at the top of this document.
10244
Jarno Huuskonene5ae7022017-04-03 14:36:21 +030010245 When a connection is tarpitted using "http-request tarpit" or
10246 "reqtarpit", it is maintained open with no activity for a certain
10247 amount of time, then closed. "timeout tarpit" defines how long it will
10248 be maintained open.
Willy Tarreau844e3c52008-01-11 16:28:18 +010010249
10250 The value is specified in milliseconds by default, but can be in any other
10251 unit if the number is suffixed by the unit, as specified at the top of this
10252 document. If unspecified, the same value as the backend's connection timeout
10253 ("timeout connect") is used, for backwards compatibility with older versions
Cyril Bonté78caf842010-03-10 22:41:43 +010010254 with no "timeout tarpit" parameter.
Willy Tarreau844e3c52008-01-11 16:28:18 +010010255
10256 See also : "timeout connect", "contimeout".
10257
10258
Willy Tarreauce887fd2012-05-12 12:50:00 +020010259timeout tunnel <timeout>
10260 Set the maximum inactivity time on the client and server side for tunnels.
10261 May be used in sections : defaults | frontend | listen | backend
10262 yes | no | yes | yes
10263 Arguments :
10264 <timeout> is the timeout value specified in milliseconds by default, but
10265 can be in any other unit if the number is suffixed by the unit,
10266 as explained at the top of this document.
10267
Jamie Gloudonaaa21002012-08-25 00:18:33 -040010268 The tunnel timeout applies when a bidirectional connection is established
Willy Tarreauce887fd2012-05-12 12:50:00 +020010269 between a client and a server, and the connection remains inactive in both
10270 directions. This timeout supersedes both the client and server timeouts once
10271 the connection becomes a tunnel. In TCP, this timeout is used as soon as no
Davor Ocelice9ed2812017-12-25 17:49:28 +010010272 analyzer remains attached to either connection (e.g. tcp content rules are
10273 accepted). In HTTP, this timeout is used when a connection is upgraded (e.g.
Willy Tarreauce887fd2012-05-12 12:50:00 +020010274 when switching to the WebSocket protocol, or forwarding a CONNECT request
10275 to a proxy), or after the first response when no keepalive/close option is
10276 specified.
10277
Willy Tarreau05cdd962014-05-10 14:30:07 +020010278 Since this timeout is usually used in conjunction with long-lived connections,
10279 it usually is a good idea to also set "timeout client-fin" to handle the
10280 situation where a client suddenly disappears from the net and does not
10281 acknowledge a close, or sends a shutdown and does not acknowledge pending
10282 data anymore. This can happen in lossy networks where firewalls are present,
10283 and is detected by the presence of large amounts of sessions in a FIN_WAIT
10284 state.
10285
Willy Tarreauce887fd2012-05-12 12:50:00 +020010286 The value is specified in milliseconds by default, but can be in any other
10287 unit if the number is suffixed by the unit, as specified at the top of this
10288 document. Whatever the expected normal idle time, it is a good practice to
10289 cover at least one or several TCP packet losses by specifying timeouts that
Davor Ocelice9ed2812017-12-25 17:49:28 +010010290 are slightly above multiples of 3 seconds (e.g. 4 or 5 seconds minimum).
Willy Tarreauce887fd2012-05-12 12:50:00 +020010291
10292 This parameter is specific to backends, but can be specified once for all in
10293 "defaults" sections. This is in fact one of the easiest solutions not to
10294 forget about it.
10295
10296 Example :
10297 defaults http
10298 option http-server-close
10299 timeout connect 5s
10300 timeout client 30s
Willy Tarreau05cdd962014-05-10 14:30:07 +020010301 timeout client-fin 30s
Willy Tarreauce887fd2012-05-12 12:50:00 +020010302 timeout server 30s
10303 timeout tunnel 1h # timeout to use with WebSocket and CONNECT
10304
Willy Tarreau05cdd962014-05-10 14:30:07 +020010305 See also : "timeout client", "timeout client-fin", "timeout server".
Willy Tarreauce887fd2012-05-12 12:50:00 +020010306
10307
Willy Tarreau844e3c52008-01-11 16:28:18 +010010308transparent (deprecated)
10309 Enable client-side transparent proxying
10310 May be used in sections : defaults | frontend | listen | backend
Willy Tarreau4b1f8592008-12-23 23:13:55 +010010311 yes | no | yes | yes
Willy Tarreau844e3c52008-01-11 16:28:18 +010010312 Arguments : none
10313
10314 This keyword was introduced in order to provide layer 7 persistence to layer
10315 3 load balancers. The idea is to use the OS's ability to redirect an incoming
10316 connection for a remote address to a local process (here HAProxy), and let
10317 this process know what address was initially requested. When this option is
10318 used, sessions without cookies will be forwarded to the original destination
10319 IP address of the incoming request (which should match that of another
10320 equipment), while requests with cookies will still be forwarded to the
10321 appropriate server.
10322
10323 The "transparent" keyword is deprecated, use "option transparent" instead.
10324
10325 Note that contrary to a common belief, this option does NOT make HAProxy
10326 present the client's IP to the server when establishing the connection.
10327
Willy Tarreau844e3c52008-01-11 16:28:18 +010010328 See also: "option transparent"
10329
William Lallemanda73203e2012-03-12 12:48:57 +010010330unique-id-format <string>
10331 Generate a unique ID for each request.
10332 May be used in sections : defaults | frontend | listen | backend
10333 yes | yes | yes | no
10334 Arguments :
10335 <string> is a log-format string.
10336
Cyril Bonté108cf6e2012-04-21 23:30:29 +020010337 This keyword creates a ID for each request using the custom log format. A
10338 unique ID is useful to trace a request passing through many components of
10339 a complex infrastructure. The newly created ID may also be logged using the
10340 %ID tag the log-format string.
William Lallemanda73203e2012-03-12 12:48:57 +010010341
Cyril Bonté108cf6e2012-04-21 23:30:29 +020010342 The format should be composed from elements that are guaranteed to be
10343 unique when combined together. For instance, if multiple haproxy instances
10344 are involved, it might be important to include the node name. It is often
10345 needed to log the incoming connection's source and destination addresses
10346 and ports. Note that since multiple requests may be performed over the same
10347 connection, including a request counter may help differentiate them.
10348 Similarly, a timestamp may protect against a rollover of the counter.
10349 Logging the process ID will avoid collisions after a service restart.
William Lallemanda73203e2012-03-12 12:48:57 +010010350
Cyril Bonté108cf6e2012-04-21 23:30:29 +020010351 It is recommended to use hexadecimal notation for many fields since it
10352 makes them more compact and saves space in logs.
William Lallemanda73203e2012-03-12 12:48:57 +010010353
Cyril Bonté108cf6e2012-04-21 23:30:29 +020010354 Example:
William Lallemanda73203e2012-03-12 12:48:57 +010010355
Julien Vehentf21be322014-03-07 08:27:34 -050010356 unique-id-format %{+X}o\ %ci:%cp_%fi:%fp_%Ts_%rt:%pid
William Lallemanda73203e2012-03-12 12:48:57 +010010357
10358 will generate:
10359
10360 7F000001:8296_7F00001E:1F90_4F7B0A69_0003:790A
10361
10362 See also: "unique-id-header"
10363
10364unique-id-header <name>
10365 Add a unique ID header in the HTTP request.
10366 May be used in sections : defaults | frontend | listen | backend
10367 yes | yes | yes | no
10368 Arguments :
10369 <name> is the name of the header.
10370
Cyril Bonté108cf6e2012-04-21 23:30:29 +020010371 Add a unique-id header in the HTTP request sent to the server, using the
10372 unique-id-format. It can't work if the unique-id-format doesn't exist.
William Lallemanda73203e2012-03-12 12:48:57 +010010373
Cyril Bonté108cf6e2012-04-21 23:30:29 +020010374 Example:
William Lallemanda73203e2012-03-12 12:48:57 +010010375
Julien Vehentf21be322014-03-07 08:27:34 -050010376 unique-id-format %{+X}o\ %ci:%cp_%fi:%fp_%Ts_%rt:%pid
William Lallemanda73203e2012-03-12 12:48:57 +010010377 unique-id-header X-Unique-ID
10378
10379 will generate:
10380
10381 X-Unique-ID: 7F000001:8296_7F00001E:1F90_4F7B0A69_0003:790A
10382
10383 See also: "unique-id-format"
Willy Tarreau844e3c52008-01-11 16:28:18 +010010384
Willy Tarreauf51658d2014-04-23 01:21:56 +020010385use_backend <backend> [{if | unless} <condition>]
Willy Tarreau1d0dfb12009-07-07 15:10:31 +020010386 Switch to a specific backend if/unless an ACL-based condition is matched.
Willy Tarreau844e3c52008-01-11 16:28:18 +010010387 May be used in sections : defaults | frontend | listen | backend
10388 no | yes | yes | no
10389 Arguments :
Bertrand Jacquin702d44f2013-11-19 11:43:06 +010010390 <backend> is the name of a valid backend or "listen" section, or a
10391 "log-format" string resolving to a backend name.
Willy Tarreau844e3c52008-01-11 16:28:18 +010010392
Willy Tarreauf51658d2014-04-23 01:21:56 +020010393 <condition> is a condition composed of ACLs, as described in section 7. If
10394 it is omitted, the rule is unconditionally applied.
Willy Tarreau844e3c52008-01-11 16:28:18 +010010395
10396 When doing content-switching, connections arrive on a frontend and are then
10397 dispatched to various backends depending on a number of conditions. The
10398 relation between the conditions and the backends is described with the
Willy Tarreau1d0dfb12009-07-07 15:10:31 +020010399 "use_backend" keyword. While it is normally used with HTTP processing, it can
Davor Ocelice9ed2812017-12-25 17:49:28 +010010400 also be used in pure TCP, either without content using stateless ACLs (e.g.
Willy Tarreau1d0dfb12009-07-07 15:10:31 +020010401 source address validation) or combined with a "tcp-request" rule to wait for
10402 some payload.
Willy Tarreau844e3c52008-01-11 16:28:18 +010010403
10404 There may be as many "use_backend" rules as desired. All of these rules are
10405 evaluated in their declaration order, and the first one which matches will
10406 assign the backend.
10407
10408 In the first form, the backend will be used if the condition is met. In the
10409 second form, the backend will be used if the condition is not met. If no
10410 condition is valid, the backend defined with "default_backend" will be used.
10411 If no default backend is defined, either the servers in the same section are
10412 used (in case of a "listen" section) or, in case of a frontend, no server is
10413 used and a 503 service unavailable response is returned.
10414
Willy Tarreau51aecc72009-07-12 09:47:04 +020010415 Note that it is possible to switch from a TCP frontend to an HTTP backend. In
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +010010416 this case, either the frontend has already checked that the protocol is HTTP,
Willy Tarreau51aecc72009-07-12 09:47:04 +020010417 and backend processing will immediately follow, or the backend will wait for
10418 a complete HTTP request to get in. This feature is useful when a frontend
10419 must decode several protocols on a unique port, one of them being HTTP.
10420
Bertrand Jacquin702d44f2013-11-19 11:43:06 +010010421 When <backend> is a simple name, it is resolved at configuration time, and an
10422 error is reported if the specified backend does not exist. If <backend> is
10423 a log-format string instead, no check may be done at configuration time, so
10424 the backend name is resolved dynamically at run time. If the resulting
10425 backend name does not correspond to any valid backend, no other rule is
10426 evaluated, and the default_backend directive is applied instead. Note that
10427 when using dynamic backend names, it is highly recommended to use a prefix
10428 that no other backend uses in order to ensure that an unauthorized backend
10429 cannot be forced from the request.
10430
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030010431 It is worth mentioning that "use_backend" rules with an explicit name are
Bertrand Jacquin702d44f2013-11-19 11:43:06 +010010432 used to detect the association between frontends and backends to compute the
10433 backend's "fullconn" setting. This cannot be done for dynamic names.
10434
10435 See also: "default_backend", "tcp-request", "fullconn", "log-format", and
10436 section 7 about ACLs.
Willy Tarreaud72758d2010-01-12 10:42:19 +010010437
Willy Tarreau036fae02008-01-06 13:24:40 +010010438
Willy Tarreau4a5cade2012-04-05 21:09:48 +020010439use-server <server> if <condition>
10440use-server <server> unless <condition>
10441 Only use a specific server if/unless an ACL-based condition is matched.
10442 May be used in sections : defaults | frontend | listen | backend
10443 no | no | yes | yes
10444 Arguments :
Cyril Bonté108cf6e2012-04-21 23:30:29 +020010445 <server> is the name of a valid server in the same backend section.
Willy Tarreau4a5cade2012-04-05 21:09:48 +020010446
10447 <condition> is a condition composed of ACLs, as described in section 7.
10448
10449 By default, connections which arrive to a backend are load-balanced across
10450 the available servers according to the configured algorithm, unless a
10451 persistence mechanism such as a cookie is used and found in the request.
10452
10453 Sometimes it is desirable to forward a particular request to a specific
10454 server without having to declare a dedicated backend for this server. This
10455 can be achieved using the "use-server" rules. These rules are evaluated after
10456 the "redirect" rules and before evaluating cookies, and they have precedence
10457 on them. There may be as many "use-server" rules as desired. All of these
10458 rules are evaluated in their declaration order, and the first one which
10459 matches will assign the server.
10460
10461 If a rule designates a server which is down, and "option persist" is not used
10462 and no force-persist rule was validated, it is ignored and evaluation goes on
10463 with the next rules until one matches.
10464
10465 In the first form, the server will be used if the condition is met. In the
10466 second form, the server will be used if the condition is not met. If no
10467 condition is valid, the processing continues and the server will be assigned
10468 according to other persistence mechanisms.
10469
10470 Note that even if a rule is matched, cookie processing is still performed but
10471 does not assign the server. This allows prefixed cookies to have their prefix
10472 stripped.
10473
10474 The "use-server" statement works both in HTTP and TCP mode. This makes it
10475 suitable for use with content-based inspection. For instance, a server could
10476 be selected in a farm according to the TLS SNI field. And if these servers
10477 have their weight set to zero, they will not be used for other traffic.
10478
10479 Example :
10480 # intercept incoming TLS requests based on the SNI field
10481 use-server www if { req_ssl_sni -i www.example.com }
10482 server www 192.168.0.1:443 weight 0
10483 use-server mail if { req_ssl_sni -i mail.example.com }
10484 server mail 192.168.0.1:587 weight 0
10485 use-server imap if { req_ssl_sni -i imap.example.com }
Lukas Tribus98a3e3f2017-03-26 12:55:35 +000010486 server imap 192.168.0.1:993 weight 0
Willy Tarreau4a5cade2012-04-05 21:09:48 +020010487 # all the rest is forwarded to this server
10488 server default 192.168.0.2:443 check
10489
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030010490 See also: "use_backend", section 5 about server and section 7 about ACLs.
Willy Tarreau4a5cade2012-04-05 21:09:48 +020010491
Willy Tarreaub6205fd2012-09-24 12:27:33 +020010492
Davor Ocelice9ed2812017-12-25 17:49:28 +0100104935. Bind and server options
Willy Tarreaub6205fd2012-09-24 12:27:33 +020010494--------------------------
10495
10496The "bind", "server" and "default-server" keywords support a number of settings
10497depending on some build options and on the system HAProxy was built on. These
10498settings generally each consist in one word sometimes followed by a value,
10499written on the same line as the "bind" or "server" line. All these options are
10500described in this section.
10501
10502
105035.1. Bind options
10504-----------------
10505
10506The "bind" keyword supports a certain number of settings which are all passed
10507as arguments on the same line. The order in which those arguments appear makes
10508no importance, provided that they appear after the bind address. All of these
10509parameters are optional. Some of them consist in a single words (booleans),
10510while other ones expect a value after them. In this case, the value must be
10511provided immediately after the setting name.
10512
10513The currently supported settings are the following ones.
10514
Bertrand Jacquin93b227d2016-06-04 15:11:10 +010010515accept-netscaler-cip <magic number>
10516 Enforces the use of the NetScaler Client IP insertion protocol over any
10517 connection accepted by any of the TCP sockets declared on the same line. The
10518 NetScaler Client IP insertion protocol dictates the layer 3/4 addresses of
10519 the incoming connection to be used everywhere an address is used, with the
10520 only exception of "tcp-request connection" rules which will only see the
10521 real connection address. Logs will reflect the addresses indicated in the
10522 protocol, unless it is violated, in which case the real address will still
10523 be used. This keyword combined with support from external components can be
10524 used as an efficient and reliable alternative to the X-Forwarded-For
Bertrand Jacquin90759682016-06-06 15:35:39 +010010525 mechanism which is not always reliable and not even always usable. See also
10526 "tcp-request connection expect-netscaler-cip" for a finer-grained setting of
10527 which client is allowed to use the protocol.
Bertrand Jacquin93b227d2016-06-04 15:11:10 +010010528
Willy Tarreaub6205fd2012-09-24 12:27:33 +020010529accept-proxy
10530 Enforces the use of the PROXY protocol over any connection accepted by any of
Willy Tarreau77992672014-06-14 11:06:17 +020010531 the sockets declared on the same line. Versions 1 and 2 of the PROXY protocol
10532 are supported and correctly detected. The PROXY protocol dictates the layer
Willy Tarreaub6205fd2012-09-24 12:27:33 +020010533 3/4 addresses of the incoming connection to be used everywhere an address is
10534 used, with the only exception of "tcp-request connection" rules which will
10535 only see the real connection address. Logs will reflect the addresses
10536 indicated in the protocol, unless it is violated, in which case the real
Davor Ocelice9ed2812017-12-25 17:49:28 +010010537 address will still be used. This keyword combined with support from external
Willy Tarreaub6205fd2012-09-24 12:27:33 +020010538 components can be used as an efficient and reliable alternative to the
10539 X-Forwarded-For mechanism which is not always reliable and not even always
Willy Tarreau4f0d9192013-06-11 20:40:55 +020010540 usable. See also "tcp-request connection expect-proxy" for a finer-grained
10541 setting of which client is allowed to use the protocol.
Willy Tarreaub6205fd2012-09-24 12:27:33 +020010542
Olivier Houchardc2aae742017-09-22 18:26:28 +020010543allow-0rtt
Bertrand Jacquina25282b2018-08-14 00:56:13 +010010544 Allow receiving early data when using TLSv1.3. This is disabled by default,
Olivier Houchardc2aae742017-09-22 18:26:28 +020010545 due to security considerations.
10546
Willy Tarreauab861d32013-04-02 02:30:41 +020010547alpn <protocols>
10548 This enables the TLS ALPN extension and advertises the specified protocol
10549 list as supported on top of ALPN. The protocol list consists in a comma-
10550 delimited list of protocol names, for instance: "http/1.1,http/1.0" (without
10551 quotes). This requires that the SSL library is build with support for TLS
10552 extensions enabled (check with haproxy -vv). The ALPN extension replaces the
Willy Tarreau95c4e142017-11-26 12:18:55 +010010553 initial NPN extension. ALPN is required to enable HTTP/2 on an HTTP frontend.
10554 Versions of OpenSSL prior to 1.0.2 didn't support ALPN and only supposed the
10555 now obsolete NPN extension. At the time of writing this, most browsers still
10556 support both ALPN and NPN for HTTP/2 so a fallback to NPN may still work for
10557 a while. But ALPN must be used whenever possible. If both HTTP/2 and HTTP/1.1
10558 are expected to be supported, both versions can be advertised, in order of
10559 preference, like below :
10560
10561 bind :443 ssl crt pub.pem alpn h2,http/1.1
Willy Tarreauab861d32013-04-02 02:30:41 +020010562
Willy Tarreaub6205fd2012-09-24 12:27:33 +020010563backlog <backlog>
10564 Sets the socket's backlog to this value. If unspecified, the frontend's
10565 backlog is used instead, which generally defaults to the maxconn value.
10566
Emmanuel Hocdete7f2b732017-01-09 16:15:54 +010010567curves <curves>
10568 This setting is only available when support for OpenSSL was built in. It sets
10569 the string describing the list of elliptic curves algorithms ("curve suite")
10570 that are negotiated during the SSL/TLS handshake with ECDHE. The format of the
10571 string is a colon-delimited list of curve name.
10572 Example: "X25519:P-256" (without quote)
10573 When "curves" is set, "ecdhe" parameter is ignored.
10574
Emeric Brun7fb34422012-09-28 15:26:15 +020010575ecdhe <named curve>
10576 This setting is only available when support for OpenSSL was built in. It sets
Emeric Brun6924ef82013-03-06 14:08:53 +010010577 the named curve (RFC 4492) used to generate ECDH ephemeral keys. By default,
10578 used named curve is prime256v1.
Emeric Brun7fb34422012-09-28 15:26:15 +020010579
Emeric Brunfd33a262012-10-11 16:28:27 +020010580ca-file <cafile>
Emeric Brun1a073b42012-09-28 17:07:34 +020010581 This setting is only available when support for OpenSSL was built in. It
10582 designates a PEM file from which to load CA certificates used to verify
10583 client's certificate.
10584
Emeric Brunb6dc9342012-09-28 17:55:37 +020010585ca-ignore-err [all|<errorID>,...]
10586 This setting is only available when support for OpenSSL was built in.
10587 Sets a comma separated list of errorIDs to ignore during verify at depth > 0.
10588 If set to 'all', all errors are ignored. SSL handshake is not aborted if an
10589 error is ignored.
10590
Christopher Faulet31af49d2015-06-09 17:29:50 +020010591ca-sign-file <cafile>
10592 This setting is only available when support for OpenSSL was built in. It
10593 designates a PEM file containing both the CA certificate and the CA private
10594 key used to create and sign server's certificates. This is a mandatory
10595 setting when the dynamic generation of certificates is enabled. See
10596 'generate-certificates' for details.
10597
Bertrand Jacquind4d0a232016-11-13 16:37:12 +000010598ca-sign-pass <passphrase>
Christopher Faulet31af49d2015-06-09 17:29:50 +020010599 This setting is only available when support for OpenSSL was built in. It is
10600 the CA private key passphrase. This setting is optional and used only when
10601 the dynamic generation of certificates is enabled. See
10602 'generate-certificates' for details.
10603
Willy Tarreaub6205fd2012-09-24 12:27:33 +020010604ciphers <ciphers>
10605 This setting is only available when support for OpenSSL was built in. It sets
10606 the string describing the list of cipher algorithms ("cipher suite") that are
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030010607 negotiated during the SSL/TLS handshake. The format of the string is defined
Willy Tarreaub6205fd2012-09-24 12:27:33 +020010608 in "man 1 ciphers" from OpenSSL man pages, and can be for instance a string
10609 such as "AES:ALL:!aNULL:!eNULL:+RC4:@STRENGTH" (without quotes).
Davor Ocelice9ed2812017-12-25 17:49:28 +010010610 Depending on the compatibility and security requirements, the list of suitable
Daniel Schneller87e43022017-09-01 19:29:57 +020010611 ciphers depends on a variety of variables. For background information and
10612 recommendations see e. g. (https://wiki.mozilla.org/Security/Server_Side_TLS)
10613 and (https://mozilla.github.io/server-side-tls/ssl-config-generator/).
Willy Tarreaub6205fd2012-09-24 12:27:33 +020010614
Emeric Brunfd33a262012-10-11 16:28:27 +020010615crl-file <crlfile>
Emeric Brun1a073b42012-09-28 17:07:34 +020010616 This setting is only available when support for OpenSSL was built in. It
10617 designates a PEM file from which to load certificate revocation list used
10618 to verify client's certificate.
10619
Willy Tarreaub6205fd2012-09-24 12:27:33 +020010620crt <cert>
Alex Davies0fbf0162013-03-02 16:04:50 +000010621 This setting is only available when support for OpenSSL was built in. It
10622 designates a PEM file containing both the required certificates and any
10623 associated private keys. This file can be built by concatenating multiple
10624 PEM files into one (e.g. cat cert.pem key.pem > combined.pem). If your CA
10625 requires an intermediate certificate, this can also be concatenated into this
10626 file.
10627
10628 If the OpenSSL used supports Diffie-Hellman, parameters present in this file
10629 are loaded.
10630
10631 If a directory name is used instead of a PEM file, then all files found in
Cyril Bonté3180f7b2015-01-25 00:16:08 +010010632 that directory will be loaded in alphabetic order unless their name ends with
Janusz Dziemidowicz2c701b52015-03-07 23:03:59 +010010633 '.issuer', '.ocsp' or '.sctl' (reserved extensions). This directive may be
10634 specified multiple times in order to load certificates from multiple files or
10635 directories. The certificates will be presented to clients who provide a
10636 valid TLS Server Name Indication field matching one of their CN or alt
Davor Ocelice9ed2812017-12-25 17:49:28 +010010637 subjects. Wildcards are supported, where a wildcard character '*' is used
10638 instead of the first hostname component (e.g. *.example.org matches
Janusz Dziemidowicz2c701b52015-03-07 23:03:59 +010010639 www.example.org but not www.sub.example.org).
Alex Davies0fbf0162013-03-02 16:04:50 +000010640
10641 If no SNI is provided by the client or if the SSL library does not support
10642 TLS extensions, or if the client provides an SNI hostname which does not
10643 match any certificate, then the first loaded certificate will be presented.
10644 This means that when loading certificates from a directory, it is highly
Cyril Bonté3180f7b2015-01-25 00:16:08 +010010645 recommended to load the default one first as a file or to ensure that it will
10646 always be the first one in the directory.
Alex Davies0fbf0162013-03-02 16:04:50 +000010647
Emeric Brune032bfa2012-09-28 13:01:45 +020010648 Note that the same cert may be loaded multiple times without side effects.
Willy Tarreaub6205fd2012-09-24 12:27:33 +020010649
Davor Ocelice9ed2812017-12-25 17:49:28 +010010650 Some CAs (such as GoDaddy) offer a drop down list of server types that do not
Alex Davies0fbf0162013-03-02 16:04:50 +000010651 include HAProxy when obtaining a certificate. If this happens be sure to
Davor Ocelice9ed2812017-12-25 17:49:28 +010010652 choose a web server that the CA believes requires an intermediate CA (for
10653 GoDaddy, selection Apache Tomcat will get the correct bundle, but many
Alex Davies0fbf0162013-03-02 16:04:50 +000010654 others, e.g. nginx, result in a wrong bundle that will not work for some
10655 clients).
10656
Emeric Brun4147b2e2014-06-16 18:36:30 +020010657 For each PEM file, haproxy checks for the presence of file at the same path
10658 suffixed by ".ocsp". If such file is found, support for the TLS Certificate
10659 Status Request extension (also known as "OCSP stapling") is automatically
10660 enabled. The content of this file is optional. If not empty, it must contain
10661 a valid OCSP Response in DER format. In order to be valid an OCSP Response
10662 must comply with the following rules: it has to indicate a good status,
10663 it has to be a single response for the certificate of the PEM file, and it
10664 has to be valid at the moment of addition. If these rules are not respected
10665 the OCSP Response is ignored and a warning is emitted. In order to identify
10666 which certificate an OCSP Response applies to, the issuer's certificate is
10667 necessary. If the issuer's certificate is not found in the PEM file, it will
10668 be loaded from a file at the same path as the PEM file suffixed by ".issuer"
10669 if it exists otherwise it will fail with an error.
10670
Janusz Dziemidowicz2c701b52015-03-07 23:03:59 +010010671 For each PEM file, haproxy also checks for the presence of file at the same
10672 path suffixed by ".sctl". If such file is found, support for Certificate
10673 Transparency (RFC6962) TLS extension is enabled. The file must contain a
10674 valid Signed Certificate Timestamp List, as described in RFC. File is parsed
10675 to check basic syntax, but no signatures are verified.
10676
yanbzhu6c25e9e2016-01-05 12:52:02 -050010677 There are cases where it is desirable to support multiple key types, e.g. RSA
10678 and ECDSA in the cipher suites offered to the clients. This allows clients
10679 that support EC certificates to be able to use EC ciphers, while
10680 simultaneously supporting older, RSA only clients.
yanbzhud19630c2015-12-14 15:10:25 -050010681
10682 In order to provide this functionality, multiple PEM files, each with a
10683 different key type, are required. To associate these PEM files into a
10684 "cert bundle" that is recognized by haproxy, they must be named in the
10685 following way: All PEM files that are to be bundled must have the same base
10686 name, with a suffix indicating the key type. Currently, three suffixes are
10687 supported: rsa, dsa and ecdsa. For example, if www.example.com has two PEM
10688 files, an RSA file and an ECDSA file, they must be named: "example.pem.rsa"
10689 and "example.pem.ecdsa". The first part of the filename is arbitrary; only the
10690 suffix matters. To load this bundle into haproxy, specify the base name only:
10691
10692 Example : bind :8443 ssl crt example.pem
10693
yanbzhu6c25e9e2016-01-05 12:52:02 -050010694 Note that the suffix is not given to haproxy; this tells haproxy to look for
yanbzhud19630c2015-12-14 15:10:25 -050010695 a cert bundle.
10696
Davor Ocelice9ed2812017-12-25 17:49:28 +010010697 HAProxy will load all PEM files in the bundle at the same time to try to
yanbzhud19630c2015-12-14 15:10:25 -050010698 support multiple key types. PEM files are combined based on Common Name
10699 (CN) and Subject Alternative Name (SAN) to support SNI lookups. This means
10700 that even if you give haproxy a cert bundle, if there are no shared CN/SAN
10701 entries in the certificates in that bundle, haproxy will not be able to
10702 provide multi-cert support.
10703
10704 Assuming bundle in the example above contained the following:
10705
10706 Filename | CN | SAN
10707 -------------------+-----------------+-------------------
10708 example.pem.rsa | www.example.com | rsa.example.com
yanbzhu6c25e9e2016-01-05 12:52:02 -050010709 -------------------+-----------------+-------------------
yanbzhud19630c2015-12-14 15:10:25 -050010710 example.pem.ecdsa | www.example.com | ecdsa.example.com
10711 -------------------+-----------------+-------------------
10712
10713 Users connecting with an SNI of "www.example.com" will be able
10714 to use both RSA and ECDSA cipher suites. Users connecting with an SNI of
10715 "rsa.example.com" will only be able to use RSA cipher suites, and users
10716 connecting with "ecdsa.example.com" will only be able to use ECDSA cipher
Emmanuel Hocdet84e417d2017-08-16 11:33:17 +020010717 suites. With BoringSSL and Openssl >= 1.1.1 multi-cert is natively supported,
10718 no need to bundle certificates. ECDSA certificate will be preferred if client
10719 support it.
yanbzhud19630c2015-12-14 15:10:25 -050010720
10721 If a directory name is given as the <cert> argument, haproxy will
10722 automatically search and load bundled files in that directory.
10723
10724 OSCP files (.ocsp) and issuer files (.issuer) are supported with multi-cert
10725 bundling. Each certificate can have its own .ocsp and .issuer file. At this
10726 time, sctl is not supported in multi-certificate bundling.
10727
Emeric Brunb6dc9342012-09-28 17:55:37 +020010728crt-ignore-err <errors>
Alex Davies0fbf0162013-03-02 16:04:50 +000010729 This setting is only available when support for OpenSSL was built in. Sets a
Davor Ocelice9ed2812017-12-25 17:49:28 +010010730 comma separated list of errorIDs to ignore during verify at depth == 0. If
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030010731 set to 'all', all errors are ignored. SSL handshake is not aborted if an error
Alex Davies0fbf0162013-03-02 16:04:50 +000010732 is ignored.
Emeric Brunb6dc9342012-09-28 17:55:37 +020010733
Emmanuel Hocdetfe616562013-01-22 15:31:15 +010010734crt-list <file>
10735 This setting is only available when support for OpenSSL was built in. It
Emmanuel Hocdet98263292016-12-29 18:26:15 +010010736 designates a list of PEM file with an optional ssl configuration and a SNI
10737 filter per certificate, with the following format for each line :
Emmanuel Hocdetfe616562013-01-22 15:31:15 +010010738
Emmanuel Hocdet98263292016-12-29 18:26:15 +010010739 <crtfile> [\[<sslbindconf> ...\]] [[!]<snifilter> ...]
10740
Emmanuel Hocdet174dfe52017-07-28 15:01:05 +020010741 sslbindconf support "npn", "alpn", "verify", "ca-file", "no-ca-names",
10742 crl-file", "ecdhe", "curves", "ciphers" configuration. With BoringSSL
Emmanuel Hocdet84e417d2017-08-16 11:33:17 +020010743 and Openssl >= 1.1.1 "ssl-min-ver" and "ssl-max-ver" are also supported.
Emmanuel Hocdet98263292016-12-29 18:26:15 +010010744 It override the configuration set in bind line for the certificate.
Emmanuel Hocdetfe616562013-01-22 15:31:15 +010010745
Emmanuel Hocdet7c41a1b2013-05-07 20:20:06 +020010746 Wildcards are supported in the SNI filter. Negative filter are also supported,
10747 only useful in combination with a wildcard filter to exclude a particular SNI.
10748 The certificates will be presented to clients who provide a valid TLS Server
10749 Name Indication field matching one of the SNI filters. If no SNI filter is
10750 specified, the CN and alt subjects are used. This directive may be specified
10751 multiple times. See the "crt" option for more information. The default
10752 certificate is still needed to meet OpenSSL expectations. If it is not used,
10753 the 'strict-sni' option may be used.
Emmanuel Hocdetfe616562013-01-22 15:31:15 +010010754
yanbzhu6c25e9e2016-01-05 12:52:02 -050010755 Multi-cert bundling (see "crt") is supported with crt-list, as long as only
Emmanuel Hocdetd294aea2016-05-13 11:14:06 +020010756 the base name is given in the crt-list. SNI filter will do the same work on
Emmanuel Hocdet84e417d2017-08-16 11:33:17 +020010757 all bundled certificates. With BoringSSL and Openssl >= 1.1.1 multi-cert is
10758 natively supported, avoid multi-cert bundling. RSA and ECDSA certificates can
10759 be declared in a row, and set different ssl and filter parameter.
yanbzhud19630c2015-12-14 15:10:25 -050010760
Emmanuel Hocdet98263292016-12-29 18:26:15 +010010761 crt-list file example:
10762 cert1.pem
Emmanuel Hocdet05942112017-02-20 16:11:50 +010010763 cert2.pem [alpn h2,http/1.1]
Emmanuel Hocdet98263292016-12-29 18:26:15 +010010764 certW.pem *.domain.tld !secure.domain.tld
Emmanuel Hocdet05942112017-02-20 16:11:50 +010010765 certS.pem [curves X25519:P-256 ciphers ECDHE-ECDSA-AES256-GCM-SHA384] secure.domain.tld
Emmanuel Hocdet98263292016-12-29 18:26:15 +010010766
Willy Tarreaub6205fd2012-09-24 12:27:33 +020010767defer-accept
10768 Is an optional keyword which is supported only on certain Linux kernels. It
10769 states that a connection will only be accepted once some data arrive on it,
10770 or at worst after the first retransmit. This should be used only on protocols
Davor Ocelice9ed2812017-12-25 17:49:28 +010010771 for which the client talks first (e.g. HTTP). It can slightly improve
Willy Tarreaub6205fd2012-09-24 12:27:33 +020010772 performance by ensuring that most of the request is already available when
10773 the connection is accepted. On the other hand, it will not be able to detect
10774 connections which don't talk. It is important to note that this option is
10775 broken in all kernels up to 2.6.31, as the connection is never accepted until
10776 the client talks. This can cause issues with front firewalls which would see
10777 an established connection while the proxy will only see it in SYN_RECV. This
10778 option is only supported on TCPv4/TCPv6 sockets and ignored by other ones.
10779
William Lallemandf6975e92017-05-26 17:42:10 +020010780expose-fd listeners
10781 This option is only usable with the stats socket. It gives your stats socket
10782 the capability to pass listeners FD to another HAProxy process.
William Lallemande202b1e2017-06-01 17:38:56 +020010783 During a reload with the master-worker mode, the process is automatically
10784 reexecuted adding -x and one of the stats socket with this option.
Davor Ocelice9ed2812017-12-25 17:49:28 +010010785 See also "-x" in the management guide.
William Lallemandf6975e92017-05-26 17:42:10 +020010786
Emeric Brun2cb7ae52012-10-05 14:14:21 +020010787force-sslv3
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030010788 This option enforces use of SSLv3 only on SSL connections instantiated from
Emeric Brun2cb7ae52012-10-05 14:14:21 +020010789 this listener. SSLv3 is generally less expensive than the TLS counterparts
Emeric Brun2c86cbf2014-10-30 15:56:50 +010010790 for high connection rates. This option is also available on global statement
Emmanuel Hocdete1c722b2017-03-31 15:02:54 +020010791 "ssl-default-bind-options". See also "ssl-min-ver" and "ssl-max-ver".
Emeric Brun2cb7ae52012-10-05 14:14:21 +020010792
10793force-tlsv10
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030010794 This option enforces use of TLSv1.0 only on SSL connections instantiated from
Emeric Brun2c86cbf2014-10-30 15:56:50 +010010795 this listener. This option is also available on global statement
Emmanuel Hocdete1c722b2017-03-31 15:02:54 +020010796 "ssl-default-bind-options". See also "ssl-min-ver" and "ssl-max-ver".
Emeric Brun2cb7ae52012-10-05 14:14:21 +020010797
10798force-tlsv11
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030010799 This option enforces use of TLSv1.1 only on SSL connections instantiated from
Emeric Brun2c86cbf2014-10-30 15:56:50 +010010800 this listener. This option is also available on global statement
Emmanuel Hocdete1c722b2017-03-31 15:02:54 +020010801 "ssl-default-bind-options". See also "ssl-min-ver" and "ssl-max-ver".
Emeric Brun2cb7ae52012-10-05 14:14:21 +020010802
10803force-tlsv12
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030010804 This option enforces use of TLSv1.2 only on SSL connections instantiated from
Emeric Brun2c86cbf2014-10-30 15:56:50 +010010805 this listener. This option is also available on global statement
Emmanuel Hocdete1c722b2017-03-31 15:02:54 +020010806 "ssl-default-bind-options". See also "ssl-min-ver" and "ssl-max-ver".
Emeric Brun2cb7ae52012-10-05 14:14:21 +020010807
Emmanuel Hocdet42fb9802017-03-30 19:29:39 +020010808force-tlsv13
10809 This option enforces use of TLSv1.3 only on SSL connections instantiated from
10810 this listener. This option is also available on global statement
Emmanuel Hocdete1c722b2017-03-31 15:02:54 +020010811 "ssl-default-bind-options". See also "ssl-min-ver" and "ssl-max-ver".
Emmanuel Hocdet42fb9802017-03-30 19:29:39 +020010812
Christopher Faulet31af49d2015-06-09 17:29:50 +020010813generate-certificates
10814 This setting is only available when support for OpenSSL was built in. It
10815 enables the dynamic SSL certificates generation. A CA certificate and its
10816 private key are necessary (see 'ca-sign-file'). When HAProxy is configured as
10817 a transparent forward proxy, SSL requests generate errors because of a common
10818 name mismatch on the certificate presented to the client. With this option
10819 enabled, HAProxy will try to forge a certificate using the SNI hostname
10820 indicated by the client. This is done only if no certificate matches the SNI
10821 hostname (see 'crt-list'). If an error occurs, the default certificate is
10822 used, else the 'strict-sni' option is set.
10823 It can also be used when HAProxy is configured as a reverse proxy to ease the
10824 deployment of an architecture with many backends.
10825
10826 Creating a SSL certificate is an expensive operation, so a LRU cache is used
10827 to store forged certificates (see 'tune.ssl.ssl-ctx-cache-size'). It
Davor Ocelice9ed2812017-12-25 17:49:28 +010010828 increases the HAProxy's memory footprint to reduce latency when the same
Christopher Faulet31af49d2015-06-09 17:29:50 +020010829 certificate is used many times.
10830
Willy Tarreaub6205fd2012-09-24 12:27:33 +020010831gid <gid>
10832 Sets the group of the UNIX sockets to the designated system gid. It can also
10833 be set by default in the global section's "unix-bind" statement. Note that
10834 some platforms simply ignore this. This setting is equivalent to the "group"
10835 setting except that the group ID is used instead of its name. This setting is
10836 ignored by non UNIX sockets.
10837
10838group <group>
10839 Sets the group of the UNIX sockets to the designated system group. It can
10840 also be set by default in the global section's "unix-bind" statement. Note
10841 that some platforms simply ignore this. This setting is equivalent to the
10842 "gid" setting except that the group name is used instead of its gid. This
10843 setting is ignored by non UNIX sockets.
10844
10845id <id>
10846 Fixes the socket ID. By default, socket IDs are automatically assigned, but
10847 sometimes it is more convenient to fix them to ease monitoring. This value
10848 must be strictly positive and unique within the listener/frontend. This
10849 option can only be used when defining only a single socket.
10850
10851interface <interface>
Lukas Tribusfce2e962013-02-12 22:13:19 +010010852 Restricts the socket to a specific interface. When specified, only packets
10853 received from that particular interface are processed by the socket. This is
10854 currently only supported on Linux. The interface must be a primary system
10855 interface, not an aliased interface. It is also possible to bind multiple
10856 frontends to the same address if they are bound to different interfaces. Note
10857 that binding to a network interface requires root privileges. This parameter
Jérôme Magnin61275192018-02-07 11:39:58 +010010858 is only compatible with TCPv4/TCPv6 sockets. When specified, return traffic
10859 uses the same interface as inbound traffic, and its associated routing table,
10860 even if there are explicit routes through different interfaces configured.
10861 This can prove useful to address asymmetric routing issues when the same
10862 client IP addresses need to be able to reach frontends hosted on different
10863 interfaces.
Willy Tarreaub6205fd2012-09-24 12:27:33 +020010864
Willy Tarreauabb175f2012-09-24 12:43:26 +020010865level <level>
10866 This setting is used with the stats sockets only to restrict the nature of
10867 the commands that can be issued on the socket. It is ignored by other
10868 sockets. <level> can be one of :
Davor Ocelice9ed2812017-12-25 17:49:28 +010010869 - "user" is the least privileged level; only non-sensitive stats can be
Willy Tarreauabb175f2012-09-24 12:43:26 +020010870 read, and no change is allowed. It would make sense on systems where it
10871 is not easy to restrict access to the socket.
10872 - "operator" is the default level and fits most common uses. All data can
Davor Ocelice9ed2812017-12-25 17:49:28 +010010873 be read, and only non-sensitive changes are permitted (e.g. clear max
Willy Tarreauabb175f2012-09-24 12:43:26 +020010874 counters).
Davor Ocelice9ed2812017-12-25 17:49:28 +010010875 - "admin" should be used with care, as everything is permitted (e.g. clear
Willy Tarreauabb175f2012-09-24 12:43:26 +020010876 all counters).
10877
Andjelko Iharosc4df59e2017-07-20 11:59:48 +020010878severity-output <format>
10879 This setting is used with the stats sockets only to configure severity
10880 level output prepended to informational feedback messages. Severity
10881 level of messages can range between 0 and 7, conforming to syslog
10882 rfc5424. Valid and successful socket commands requesting data
10883 (i.e. "show map", "get acl foo" etc.) will never have a severity level
10884 prepended. It is ignored by other sockets. <format> can be one of :
10885 - "none" (default) no severity level is prepended to feedback messages.
10886 - "number" severity level is prepended as a number.
10887 - "string" severity level is prepended as a string following the
10888 rfc5424 convention.
10889
Willy Tarreaub6205fd2012-09-24 12:27:33 +020010890maxconn <maxconn>
10891 Limits the sockets to this number of concurrent connections. Extraneous
10892 connections will remain in the system's backlog until a connection is
10893 released. If unspecified, the limit will be the same as the frontend's
10894 maxconn. Note that in case of port ranges or multiple addresses, the same
10895 value will be applied to each socket. This setting enables different
10896 limitations on expensive sockets, for instance SSL entries which may easily
10897 eat all memory.
10898
10899mode <mode>
10900 Sets the octal mode used to define access permissions on the UNIX socket. It
10901 can also be set by default in the global section's "unix-bind" statement.
10902 Note that some platforms simply ignore this. This setting is ignored by non
10903 UNIX sockets.
10904
10905mss <maxseg>
10906 Sets the TCP Maximum Segment Size (MSS) value to be advertised on incoming
10907 connections. This can be used to force a lower MSS for certain specific
10908 ports, for instance for connections passing through a VPN. Note that this
10909 relies on a kernel feature which is theoretically supported under Linux but
10910 was buggy in all versions prior to 2.6.28. It may or may not work on other
10911 operating systems. It may also not change the advertised value but change the
10912 effective size of outgoing segments. The commonly advertised value for TCPv4
10913 over Ethernet networks is 1460 = 1500(MTU) - 40(IP+TCP). If this value is
10914 positive, it will be used as the advertised MSS. If it is negative, it will
10915 indicate by how much to reduce the incoming connection's advertised MSS for
10916 outgoing segments. This parameter is only compatible with TCP v4/v6 sockets.
10917
10918name <name>
10919 Sets an optional name for these sockets, which will be reported on the stats
10920 page.
10921
Willy Tarreaud72f0f32015-10-13 14:50:22 +020010922namespace <name>
10923 On Linux, it is possible to specify which network namespace a socket will
10924 belong to. This directive makes it possible to explicitly bind a listener to
10925 a namespace different from the default one. Please refer to your operating
10926 system's documentation to find more details about network namespaces.
10927
Willy Tarreaub6205fd2012-09-24 12:27:33 +020010928nice <nice>
10929 Sets the 'niceness' of connections initiated from the socket. Value must be
10930 in the range -1024..1024 inclusive, and defaults to zero. Positive values
10931 means that such connections are more friendly to others and easily offer
10932 their place in the scheduler. On the opposite, negative values mean that
10933 connections want to run with a higher priority than others. The difference
10934 only happens under high loads when the system is close to saturation.
10935 Negative values are appropriate for low-latency or administration services,
10936 and high values are generally recommended for CPU intensive tasks such as SSL
10937 processing or bulk transfers which are less sensible to latency. For example,
10938 it may make sense to use a positive value for an SMTP socket and a negative
10939 one for an RDP socket.
10940
Emmanuel Hocdet174dfe52017-07-28 15:01:05 +020010941no-ca-names
10942 This setting is only available when support for OpenSSL was built in. It
10943 prevents from send CA names in server hello message when ca-file is used.
10944
Emeric Brun9b3009b2012-10-05 11:55:06 +020010945no-sslv3
Willy Tarreaub6205fd2012-09-24 12:27:33 +020010946 This setting is only available when support for OpenSSL was built in. It
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030010947 disables support for SSLv3 on any sockets instantiated from the listener when
Willy Tarreaub6205fd2012-09-24 12:27:33 +020010948 SSL is supported. Note that SSLv2 is forced disabled in the code and cannot
Emeric Brun2c86cbf2014-10-30 15:56:50 +010010949 be enabled using any configuration option. This option is also available on
Emmanuel Hocdete1c722b2017-03-31 15:02:54 +020010950 global statement "ssl-default-bind-options". Use "ssl-min-ver" and
10951 "ssl-max-ver" instead.
Willy Tarreaub6205fd2012-09-24 12:27:33 +020010952
Emeric Brun90ad8722012-10-02 14:00:59 +020010953no-tls-tickets
10954 This setting is only available when support for OpenSSL was built in. It
10955 disables the stateless session resumption (RFC 5077 TLS Ticket
10956 extension) and force to use stateful session resumption. Stateless
Emeric Brun2c86cbf2014-10-30 15:56:50 +010010957 session resumption is more expensive in CPU usage. This option is also
10958 available on global statement "ssl-default-bind-options".
Emeric Brun90ad8722012-10-02 14:00:59 +020010959
Emeric Brun9b3009b2012-10-05 11:55:06 +020010960no-tlsv10
Willy Tarreaub6205fd2012-09-24 12:27:33 +020010961 This setting is only available when support for OpenSSL was built in. It
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030010962 disables support for TLSv1.0 on any sockets instantiated from the listener
Emeric Brun2cb7ae52012-10-05 14:14:21 +020010963 when SSL is supported. Note that SSLv2 is forced disabled in the code and
Emeric Brun2c86cbf2014-10-30 15:56:50 +010010964 cannot be enabled using any configuration option. This option is also
Emmanuel Hocdete1c722b2017-03-31 15:02:54 +020010965 available on global statement "ssl-default-bind-options". Use "ssl-min-ver"
10966 and "ssl-max-ver" instead.
Willy Tarreaub6205fd2012-09-24 12:27:33 +020010967
Emeric Brun9b3009b2012-10-05 11:55:06 +020010968no-tlsv11
Emeric Brunf5da4932012-09-28 19:42:54 +020010969 This setting is only available when support for OpenSSL was built in. It
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030010970 disables support for TLSv1.1 on any sockets instantiated from the listener
Emeric Brun2cb7ae52012-10-05 14:14:21 +020010971 when SSL is supported. Note that SSLv2 is forced disabled in the code and
Emeric Brun2c86cbf2014-10-30 15:56:50 +010010972 cannot be enabled using any configuration option. This option is also
Emmanuel Hocdete1c722b2017-03-31 15:02:54 +020010973 available on global statement "ssl-default-bind-options". Use "ssl-min-ver"
10974 and "ssl-max-ver" instead.
Emeric Brunf5da4932012-09-28 19:42:54 +020010975
Emeric Brun9b3009b2012-10-05 11:55:06 +020010976no-tlsv12
Emeric Brunf5da4932012-09-28 19:42:54 +020010977 This setting is only available when support for OpenSSL was built in. It
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030010978 disables support for TLSv1.2 on any sockets instantiated from the listener
Emeric Brun2cb7ae52012-10-05 14:14:21 +020010979 when SSL is supported. Note that SSLv2 is forced disabled in the code and
Emeric Brun2c86cbf2014-10-30 15:56:50 +010010980 cannot be enabled using any configuration option. This option is also
Emmanuel Hocdete1c722b2017-03-31 15:02:54 +020010981 available on global statement "ssl-default-bind-options". Use "ssl-min-ver"
10982 and "ssl-max-ver" instead.
Emeric Brunf5da4932012-09-28 19:42:54 +020010983
Emmanuel Hocdet42fb9802017-03-30 19:29:39 +020010984no-tlsv13
10985 This setting is only available when support for OpenSSL was built in. It
10986 disables support for TLSv1.3 on any sockets instantiated from the listener
10987 when SSL is supported. Note that SSLv2 is forced disabled in the code and
10988 cannot be enabled using any configuration option. This option is also
Emmanuel Hocdete1c722b2017-03-31 15:02:54 +020010989 available on global statement "ssl-default-bind-options". Use "ssl-min-ver"
10990 and "ssl-max-ver" instead.
Emmanuel Hocdet42fb9802017-03-30 19:29:39 +020010991
Willy Tarreau6c9a3d52012-10-18 18:57:14 +020010992npn <protocols>
10993 This enables the NPN TLS extension and advertises the specified protocol list
10994 as supported on top of NPN. The protocol list consists in a comma-delimited
10995 list of protocol names, for instance: "http/1.1,http/1.0" (without quotes).
10996 This requires that the SSL library is build with support for TLS extensions
Willy Tarreauab861d32013-04-02 02:30:41 +020010997 enabled (check with haproxy -vv). Note that the NPN extension has been
Willy Tarreau95c4e142017-11-26 12:18:55 +010010998 replaced with the ALPN extension (see the "alpn" keyword), though this one is
10999 only available starting with OpenSSL 1.0.2. If HTTP/2 is desired on an older
11000 version of OpenSSL, NPN might still be used as most clients still support it
11001 at the time of writing this. It is possible to enable both NPN and ALPN
11002 though it probably doesn't make any sense out of testing.
Willy Tarreau6c9a3d52012-10-18 18:57:14 +020011003
Lukas Tribus53ae85c2017-05-04 15:45:40 +000011004prefer-client-ciphers
11005 Use the client's preference when selecting the cipher suite, by default
11006 the server's preference is enforced. This option is also available on
11007 global statement "ssl-default-bind-options".
Lukas Tribus926594f2018-05-18 17:55:57 +020011008 Note that with OpenSSL >= 1.1.1 ChaCha20-Poly1305 is reprioritized anyway
11009 (without setting this option), if a ChaCha20-Poly1305 cipher is at the top of
11010 the client cipher list.
Lukas Tribus53ae85c2017-05-04 15:45:40 +000011011
Christopher Fauletc644fa92017-11-23 22:44:11 +010011012process <process-set>[/<thread-set>]
11013 This restricts the list of processes and/or threads on which this listener is
11014 allowed to run. It does not enforce any process but eliminates those which do
Davor Ocelice9ed2812017-12-25 17:49:28 +010011015 not match. If the frontend uses a "bind-process" setting, the intersection
Christopher Fauletc644fa92017-11-23 22:44:11 +010011016 between the two is applied. If in the end the listener is not allowed to run
11017 on any remaining process, a warning is emitted, and the listener will either
11018 run on the first process of the listener if a single process was specified,
11019 or on all of its processes if multiple processes were specified. If a thread
Davor Ocelice9ed2812017-12-25 17:49:28 +010011020 set is specified, it limits the threads allowed to process incoming
Christopher Fauletc644fa92017-11-23 22:44:11 +010011021 connections for this listener, for the corresponding process set. For the
11022 unlikely case where several ranges are needed, this directive may be
11023 repeated. <process-set> and <thread-set> must use the format
11024
11025 all | odd | even | number[-[number]]
11026
11027 Ranges can be partially defined. The higher bound can be omitted. In such
11028 case, it is replaced by the corresponding maximum value. The main purpose of
11029 this directive is to be used with the stats sockets and have one different
11030 socket per process. The second purpose is to have multiple bind lines sharing
11031 the same IP:port but not the same process in a listener, so that the system
11032 can distribute the incoming connections into multiple queues and allow a
11033 smoother inter-process load balancing. Currently Linux 3.9 and above is known
11034 for supporting this. See also "bind-process" and "nbproc".
Willy Tarreau6ae1ba62014-05-07 19:01:58 +020011035
Christopher Fauleta717b992018-04-10 14:43:00 +020011036proto <name>
11037 Forces the multiplexer's protocol to use for the incoming connections. It
11038 must be compatible with the mode of the frontend (TCP or HTTP). It must also
11039 be usable on the frontend side. The list of available protocols is reported
11040 in haproxy -vv.
11041 Idea behind this optipon is to bypass the selection of the best multiplexer's
11042 protocol for all connections instantiated from this listening socket. For
11043 instance, it is possible to force the http/2 on clear TCP by specifing "proto
11044 h2" on the bind line.
11045
Willy Tarreaub6205fd2012-09-24 12:27:33 +020011046ssl
11047 This setting is only available when support for OpenSSL was built in. It
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030011048 enables SSL deciphering on connections instantiated from this listener. A
Willy Tarreaub6205fd2012-09-24 12:27:33 +020011049 certificate is necessary (see "crt" above). All contents in the buffers will
11050 appear in clear text, so that ACLs and HTTP processing will only have access
Emmanuel Hocdetbd695fe2017-05-15 15:53:41 +020011051 to deciphered contents. SSLv3 is disabled per default, use "ssl-min-ver SSLv3"
11052 to enable it.
Willy Tarreaub6205fd2012-09-24 12:27:33 +020011053
Emmanuel Hocdete1c722b2017-03-31 15:02:54 +020011054ssl-max-ver [ SSLv3 | TLSv1.0 | TLSv1.1 | TLSv1.2 | TLSv1.3 ]
11055 This option enforces use of <version> or lower on SSL connections instantiated
11056 from this listener. This option is also available on global statement
11057 "ssl-default-bind-options". See also "ssl-min-ver".
11058
11059ssl-min-ver [ SSLv3 | TLSv1.0 | TLSv1.1 | TLSv1.2 | TLSv1.3 ]
11060 This option enforces use of <version> or upper on SSL connections instantiated
11061 from this listener. This option is also available on global statement
11062 "ssl-default-bind-options". See also "ssl-max-ver".
11063
Emmanuel Hocdet65623372013-01-24 17:17:15 +010011064strict-sni
11065 This setting is only available when support for OpenSSL was built in. The
11066 SSL/TLS negotiation is allow only if the client provided an SNI which match
11067 a certificate. The default certificate is not used.
11068 See the "crt" option for more information.
11069
Willy Tarreau2af207a2015-02-04 00:45:58 +010011070tcp-ut <delay>
Tim Düsterhus4896c442016-11-29 02:15:19 +010011071 Sets the TCP User Timeout for all incoming connections instantiated from this
Willy Tarreau2af207a2015-02-04 00:45:58 +010011072 listening socket. This option is available on Linux since version 2.6.37. It
11073 allows haproxy to configure a timeout for sockets which contain data not
Davor Ocelice9ed2812017-12-25 17:49:28 +010011074 receiving an acknowledgment for the configured delay. This is especially
Willy Tarreau2af207a2015-02-04 00:45:58 +010011075 useful on long-lived connections experiencing long idle periods such as
11076 remote terminals or database connection pools, where the client and server
11077 timeouts must remain high to allow a long period of idle, but where it is
11078 important to detect that the client has disappeared in order to release all
11079 resources associated with its connection (and the server's session). The
11080 argument is a delay expressed in milliseconds by default. This only works
11081 for regular TCP connections, and is ignored for other protocols.
11082
Willy Tarreau1c862c52012-10-05 16:21:00 +020011083tfo
Lukas Tribus0defb902013-02-13 23:35:39 +010011084 Is an optional keyword which is supported only on Linux kernels >= 3.7. It
Willy Tarreau1c862c52012-10-05 16:21:00 +020011085 enables TCP Fast Open on the listening socket, which means that clients which
11086 support this feature will be able to send a request and receive a response
11087 during the 3-way handshake starting from second connection, thus saving one
11088 round-trip after the first connection. This only makes sense with protocols
11089 that use high connection rates and where each round trip matters. This can
11090 possibly cause issues with many firewalls which do not accept data on SYN
11091 packets, so this option should only be enabled once well tested. This option
Lukas Tribus0999f762013-04-02 16:43:24 +020011092 is only supported on TCPv4/TCPv6 sockets and ignored by other ones. You may
11093 need to build HAProxy with USE_TFO=1 if your libc doesn't define
11094 TCP_FASTOPEN.
Willy Tarreau1c862c52012-10-05 16:21:00 +020011095
Nenad Merdanovic188ad3e2015-02-27 19:56:50 +010011096tls-ticket-keys <keyfile>
11097 Sets the TLS ticket keys file to load the keys from. The keys need to be 48
11098 bytes long, encoded with base64 (ex. openssl rand -base64 48). Number of keys
11099 is specified by the TLS_TICKETS_NO build option (default 3) and at least as
11100 many keys need to be present in the file. Last TLS_TICKETS_NO keys will be
11101 used for decryption and the penultimate one for encryption. This enables easy
11102 key rotation by just appending new key to the file and reloading the process.
11103 Keys must be periodically rotated (ex. every 12h) or Perfect Forward Secrecy
11104 is compromised. It is also a good idea to keep the keys off any permanent
11105 storage such as hard drives (hint: use tmpfs and don't swap those files).
11106 Lifetime hint can be changed using tune.ssl.timeout.
11107
Willy Tarreaub6205fd2012-09-24 12:27:33 +020011108transparent
11109 Is an optional keyword which is supported only on certain Linux kernels. It
11110 indicates that the addresses will be bound even if they do not belong to the
11111 local machine, and that packets targeting any of these addresses will be
11112 intercepted just as if the addresses were locally configured. This normally
11113 requires that IP forwarding is enabled. Caution! do not use this with the
11114 default address '*', as it would redirect any traffic for the specified port.
11115 This keyword is available only when HAProxy is built with USE_LINUX_TPROXY=1.
11116 This parameter is only compatible with TCPv4 and TCPv6 sockets, depending on
11117 kernel version. Some distribution kernels include backports of the feature,
11118 so check for support with your vendor.
11119
Willy Tarreau77e3af92012-11-24 15:07:23 +010011120v4v6
11121 Is an optional keyword which is supported only on most recent systems
11122 including Linux kernels >= 2.4.21. It is used to bind a socket to both IPv4
11123 and IPv6 when it uses the default address. Doing so is sometimes necessary
11124 on systems which bind to IPv6 only by default. It has no effect on non-IPv6
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030011125 sockets, and is overridden by the "v6only" option.
Willy Tarreau77e3af92012-11-24 15:07:23 +010011126
Willy Tarreau9b6700f2012-11-24 11:55:28 +010011127v6only
11128 Is an optional keyword which is supported only on most recent systems
11129 including Linux kernels >= 2.4.21. It is used to bind a socket to IPv6 only
11130 when it uses the default address. Doing so is sometimes preferred to doing it
Willy Tarreau77e3af92012-11-24 15:07:23 +010011131 system-wide as it is per-listener. It has no effect on non-IPv6 sockets and
11132 has precedence over the "v4v6" option.
Willy Tarreau9b6700f2012-11-24 11:55:28 +010011133
Willy Tarreaub6205fd2012-09-24 12:27:33 +020011134uid <uid>
11135 Sets the owner of the UNIX sockets to the designated system uid. It can also
11136 be set by default in the global section's "unix-bind" statement. Note that
11137 some platforms simply ignore this. This setting is equivalent to the "user"
11138 setting except that the user numeric ID is used instead of its name. This
11139 setting is ignored by non UNIX sockets.
11140
11141user <user>
11142 Sets the owner of the UNIX sockets to the designated system user. It can also
11143 be set by default in the global section's "unix-bind" statement. Note that
11144 some platforms simply ignore this. This setting is equivalent to the "uid"
11145 setting except that the user name is used instead of its uid. This setting is
11146 ignored by non UNIX sockets.
11147
Emeric Brun1a073b42012-09-28 17:07:34 +020011148verify [none|optional|required]
11149 This setting is only available when support for OpenSSL was built in. If set
11150 to 'none', client certificate is not requested. This is the default. In other
11151 cases, a client certificate is requested. If the client does not provide a
11152 certificate after the request and if 'verify' is set to 'required', then the
11153 handshake is aborted, while it would have succeeded if set to 'optional'. The
Emeric Brunfd33a262012-10-11 16:28:27 +020011154 certificate provided by the client is always verified using CAs from
11155 'ca-file' and optional CRLs from 'crl-file'. On verify failure the handshake
11156 is aborted, regardless of the 'verify' option, unless the error code exactly
11157 matches one of those listed with 'ca-ignore-err' or 'crt-ignore-err'.
Willy Tarreau4a5cade2012-04-05 21:09:48 +020011158
Willy Tarreaub6205fd2012-09-24 12:27:33 +0200111595.2. Server and default-server options
Cyril Bontéf0c60612010-02-06 14:44:47 +010011160------------------------------------
Willy Tarreau6a06a402007-07-15 20:15:28 +020011161
Krzysztof Piotr Oledzkic6df0662010-01-05 16:38:49 +010011162The "server" and "default-server" keywords support a certain number of settings
11163which are all passed as arguments on the server line. The order in which those
11164arguments appear does not count, and they are all optional. Some of those
11165settings are single words (booleans) while others expect one or several values
11166after them. In this case, the values must immediately follow the setting name.
11167Except default-server, all those settings must be specified after the server's
11168address if they are used:
Willy Tarreau6a06a402007-07-15 20:15:28 +020011169
Willy Tarreauc57f0e22009-05-10 13:12:33 +020011170 server <name> <address>[:port] [settings ...]
Krzysztof Piotr Oledzkic6df0662010-01-05 16:38:49 +010011171 default-server [settings ...]
Willy Tarreau6a06a402007-07-15 20:15:28 +020011172
Frédéric Lécailled2376272017-03-21 18:52:12 +010011173Note that all these settings are supported both by "server" and "default-server"
11174keywords, except "id" which is only supported by "server".
11175
Krzysztof Piotr Oledzkic53601c2010-01-06 10:50:42 +010011176The currently supported settings are the following ones.
Willy Tarreau0ba27502007-12-24 16:55:16 +010011177
Willy Tarreauceb4ac92012-04-28 00:41:46 +020011178addr <ipv4|ipv6>
Willy Tarreauc57f0e22009-05-10 13:12:33 +020011179 Using the "addr" parameter, it becomes possible to use a different IP address
Baptiste Assmann13f83532016-03-06 23:14:36 +010011180 to send health-checks or to probe the agent-check. On some servers, it may be
11181 desirable to dedicate an IP address to specific component able to perform
11182 complex tests which are more suitable to health-checks than the application.
11183 This parameter is ignored if the "check" parameter is not set. See also the
11184 "port" parameter.
Willy Tarreau6a06a402007-07-15 20:15:28 +020011185
Simon Hormand60d6912013-11-25 10:46:36 +090011186agent-check
11187 Enable an auxiliary agent check which is run independently of a regular
Willy Tarreau81f5d942013-12-09 20:51:51 +010011188 health check. An agent health check is performed by making a TCP connection
11189 to the port set by the "agent-port" parameter and reading an ASCII string.
11190 The string is made of a series of words delimited by spaces, tabs or commas
11191 in any order, optionally terminated by '\r' and/or '\n', each consisting of :
Simon Hormand60d6912013-11-25 10:46:36 +090011192
Willy Tarreau81f5d942013-12-09 20:51:51 +010011193 - An ASCII representation of a positive integer percentage, e.g. "75%".
Simon Hormand60d6912013-11-25 10:46:36 +090011194 Values in this format will set the weight proportional to the initial
Willy Tarreauc5af3a62014-10-07 15:27:33 +020011195 weight of a server as configured when haproxy starts. Note that a zero
11196 weight is reported on the stats page as "DRAIN" since it has the same
11197 effect on the server (it's removed from the LB farm).
Simon Hormand60d6912013-11-25 10:46:36 +090011198
Davor Ocelice9ed2812017-12-25 17:49:28 +010011199 - The string "maxconn:" followed by an integer (no space between). Values
11200 in this format will set the maxconn of a server. The maximum number of
11201 connections advertised needs to be multiplied by the number of load
11202 balancers and different backends that use this health check to get the
11203 total number of connections the server might receive. Example: maxconn:30
Nenad Merdanovic174dd372016-04-24 23:10:06 +020011204
Willy Tarreau81f5d942013-12-09 20:51:51 +010011205 - The word "ready". This will turn the server's administrative state to the
Davor Ocelice9ed2812017-12-25 17:49:28 +010011206 READY mode, thus canceling any DRAIN or MAINT state
Simon Hormand60d6912013-11-25 10:46:36 +090011207
Willy Tarreau81f5d942013-12-09 20:51:51 +010011208 - The word "drain". This will turn the server's administrative state to the
11209 DRAIN mode, thus it will not accept any new connections other than those
11210 that are accepted via persistence.
Simon Hormand60d6912013-11-25 10:46:36 +090011211
Willy Tarreau81f5d942013-12-09 20:51:51 +010011212 - The word "maint". This will turn the server's administrative state to the
11213 MAINT mode, thus it will not accept any new connections at all, and health
11214 checks will be stopped.
Simon Hormand60d6912013-11-25 10:46:36 +090011215
Willy Tarreau81f5d942013-12-09 20:51:51 +010011216 - The words "down", "failed", or "stopped", optionally followed by a
11217 description string after a sharp ('#'). All of these mark the server's
11218 operating state as DOWN, but since the word itself is reported on the stats
11219 page, the difference allows an administrator to know if the situation was
11220 expected or not : the service may intentionally be stopped, may appear up
Davor Ocelice9ed2812017-12-25 17:49:28 +010011221 but fail some validity tests, or may be seen as down (e.g. missing process,
Willy Tarreau81f5d942013-12-09 20:51:51 +010011222 or port not responding).
Simon Hormand60d6912013-11-25 10:46:36 +090011223
Willy Tarreau81f5d942013-12-09 20:51:51 +010011224 - The word "up" sets back the server's operating state as UP if health checks
11225 also report that the service is accessible.
Simon Hormand60d6912013-11-25 10:46:36 +090011226
Willy Tarreau81f5d942013-12-09 20:51:51 +010011227 Parameters which are not advertised by the agent are not changed. For
11228 example, an agent might be designed to monitor CPU usage and only report a
11229 relative weight and never interact with the operating status. Similarly, an
11230 agent could be designed as an end-user interface with 3 radio buttons
11231 allowing an administrator to change only the administrative state. However,
11232 it is important to consider that only the agent may revert its own actions,
11233 so if a server is set to DRAIN mode or to DOWN state using the agent, the
11234 agent must implement the other equivalent actions to bring the service into
11235 operations again.
Simon Hormand60d6912013-11-25 10:46:36 +090011236
Simon Horman2f1f9552013-11-25 10:46:37 +090011237 Failure to connect to the agent is not considered an error as connectivity
11238 is tested by the regular health check which is enabled by the "check"
Willy Tarreau81f5d942013-12-09 20:51:51 +010011239 parameter. Warning though, it is not a good idea to stop an agent after it
11240 reports "down", since only an agent reporting "up" will be able to turn the
11241 server up again. Note that the CLI on the Unix stats socket is also able to
Willy Tarreau989222a2016-01-15 10:26:26 +010011242 force an agent's result in order to work around a bogus agent if needed.
Simon Horman2f1f9552013-11-25 10:46:37 +090011243
Willy Tarreau81f5d942013-12-09 20:51:51 +010011244 Requires the "agent-port" parameter to be set. See also the "agent-inter"
Frédéric Lécailled2376272017-03-21 18:52:12 +010011245 and "no-agent-check" parameters.
Simon Hormand60d6912013-11-25 10:46:36 +090011246
James Brown55f9ff12015-10-21 18:19:05 -070011247agent-send <string>
11248 If this option is specified, haproxy will send the given string (verbatim)
11249 to the agent server upon connection. You could, for example, encode
11250 the backend name into this string, which would enable your agent to send
11251 different responses based on the backend. Make sure to include a '\n' if
11252 you want to terminate your request with a newline.
11253
Simon Hormand60d6912013-11-25 10:46:36 +090011254agent-inter <delay>
11255 The "agent-inter" parameter sets the interval between two agent checks
11256 to <delay> milliseconds. If left unspecified, the delay defaults to 2000 ms.
11257
11258 Just as with every other time-based parameter, it may be entered in any
11259 other explicit unit among { us, ms, s, m, h, d }. The "agent-inter"
11260 parameter also serves as a timeout for agent checks "timeout check" is
11261 not set. In order to reduce "resonance" effects when multiple servers are
11262 hosted on the same hardware, the agent and health checks of all servers
11263 are started with a small time offset between them. It is also possible to
11264 add some random noise in the agent and health checks interval using the
11265 global "spread-checks" keyword. This makes sense for instance when a lot
11266 of backends use the same servers.
11267
11268 See also the "agent-check" and "agent-port" parameters.
11269
Misiek768d8602017-01-09 09:52:43 +010011270agent-addr <addr>
11271 The "agent-addr" parameter sets address for agent check.
11272
11273 You can offload agent-check to another target, so you can make single place
11274 managing status and weights of servers defined in haproxy in case you can't
11275 make self-aware and self-managing services. You can specify both IP or
11276 hostname, it will be resolved.
11277
Simon Hormand60d6912013-11-25 10:46:36 +090011278agent-port <port>
11279 The "agent-port" parameter sets the TCP port used for agent checks.
11280
11281 See also the "agent-check" and "agent-inter" parameters.
11282
Willy Tarreauc57f0e22009-05-10 13:12:33 +020011283backup
11284 When "backup" is present on a server line, the server is only used in load
11285 balancing when all other non-backup servers are unavailable. Requests coming
11286 with a persistence cookie referencing the server will always be served
11287 though. By default, only the first operational backup server is used, unless
Frédéric Lécailled2376272017-03-21 18:52:12 +010011288 the "allbackups" option is set in the backend. See also the "no-backup" and
11289 "allbackups" options.
Krzysztof Piotr Oledzkic53601c2010-01-06 10:50:42 +010011290
Emeric Brunef42d922012-10-11 16:11:36 +020011291ca-file <cafile>
11292 This setting is only available when support for OpenSSL was built in. It
11293 designates a PEM file from which to load CA certificates used to verify
11294 server's certificate.
11295
Willy Tarreauc57f0e22009-05-10 13:12:33 +020011296check
11297 This option enables health checks on the server. By default, a server is
Patrick Mézardb7aeec62012-01-22 16:01:22 +010011298 always considered available. If "check" is set, the server is available when
11299 accepting periodic TCP connections, to ensure that it is really able to serve
11300 requests. The default address and port to send the tests to are those of the
11301 server, and the default source is the same as the one defined in the
11302 backend. It is possible to change the address using the "addr" parameter, the
11303 port using the "port" parameter, the source address using the "source"
11304 address, and the interval and timers using the "inter", "rise" and "fall"
Simon Hormanafc47ee2013-11-25 10:46:35 +090011305 parameters. The request method is define in the backend using the "httpchk",
11306 "smtpchk", "mysql-check", "pgsql-check" and "ssl-hello-chk" options. Please
Frédéric Lécailled2376272017-03-21 18:52:12 +010011307 refer to those options and parameters for more information. See also
11308 "no-check" option.
Krzysztof Piotr Oledzkic53601c2010-01-06 10:50:42 +010011309
Willy Tarreau6c16adc2012-10-05 00:04:16 +020011310check-send-proxy
11311 This option forces emission of a PROXY protocol line with outgoing health
11312 checks, regardless of whether the server uses send-proxy or not for the
11313 normal traffic. By default, the PROXY protocol is enabled for health checks
11314 if it is already enabled for normal traffic and if no "port" nor "addr"
11315 directive is present. However, if such a directive is present, the
11316 "check-send-proxy" option needs to be used to force the use of the
11317 protocol. See also the "send-proxy" option for more information.
11318
Olivier Houchard9130a962017-10-17 17:33:43 +020011319check-sni
11320 This option allows you to specify the SNI to be used when doing health checks
11321 over SSL.
11322
Willy Tarreau763a95b2012-10-04 23:15:39 +020011323check-ssl
11324 This option forces encryption of all health checks over SSL, regardless of
11325 whether the server uses SSL or not for the normal traffic. This is generally
11326 used when an explicit "port" or "addr" directive is specified and SSL health
11327 checks are not inherited. It is important to understand that this option
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030011328 inserts an SSL transport layer below the checks, so that a simple TCP connect
Willy Tarreau763a95b2012-10-04 23:15:39 +020011329 check becomes an SSL connect, which replaces the old ssl-hello-chk. The most
11330 common use is to send HTTPS checks by combining "httpchk" with SSL checks.
Davor Ocelice9ed2812017-12-25 17:49:28 +010011331 All SSL settings are common to health checks and traffic (e.g. ciphers).
Frédéric Lécailled2376272017-03-21 18:52:12 +010011332 See the "ssl" option for more information and "no-check-ssl" to disable
11333 this option.
Willy Tarreau763a95b2012-10-04 23:15:39 +020011334
Willy Tarreaua0ee1d02012-09-10 09:01:23 +020011335ciphers <ciphers>
11336 This option sets the string describing the list of cipher algorithms that is
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030011337 is negotiated during the SSL/TLS handshake with the server. The format of the
Willy Tarreaua0ee1d02012-09-10 09:01:23 +020011338 string is defined in "man 1 ciphers". When SSL is used to communicate with
11339 servers on the local network, it is common to see a weaker set of algorithms
11340 than what is used over the internet. Doing so reduces CPU usage on both the
11341 server and haproxy while still keeping it compatible with deployed software.
11342 Some algorithms such as RC4-SHA1 are reasonably cheap. If no security at all
11343 is needed and just connectivity, using DES can be appropriate.
11344
Willy Tarreauc57f0e22009-05-10 13:12:33 +020011345cookie <value>
11346 The "cookie" parameter sets the cookie value assigned to the server to
11347 <value>. This value will be checked in incoming requests, and the first
11348 operational server possessing the same value will be selected. In return, in
11349 cookie insertion or rewrite modes, this value will be assigned to the cookie
11350 sent to the client. There is nothing wrong in having several servers sharing
11351 the same cookie value, and it is in fact somewhat common between normal and
11352 backup servers. See also the "cookie" keyword in backend section.
11353
Emeric Brunef42d922012-10-11 16:11:36 +020011354crl-file <crlfile>
11355 This setting is only available when support for OpenSSL was built in. It
11356 designates a PEM file from which to load certificate revocation list used
11357 to verify server's certificate.
11358
Emeric Bruna7aa3092012-10-26 12:58:00 +020011359crt <cert>
11360 This setting is only available when support for OpenSSL was built in.
11361 It designates a PEM file from which to load both a certificate and the
11362 associated private key. This file can be built by concatenating both PEM
11363 files into one. This certificate will be sent if the server send a client
11364 certificate request.
11365
Willy Tarreau96839092010-03-29 10:02:24 +020011366disabled
11367 The "disabled" keyword starts the server in the "disabled" state. That means
11368 that it is marked down in maintenance mode, and no connection other than the
11369 ones allowed by persist mode will reach it. It is very well suited to setup
11370 new servers, because normal traffic will never reach them, while it is still
11371 possible to test the service by making use of the force-persist mechanism.
Frédéric Lécailled2376272017-03-21 18:52:12 +010011372 See also "enabled" setting.
Willy Tarreau96839092010-03-29 10:02:24 +020011373
Frédéric Lécailled2376272017-03-21 18:52:12 +010011374enabled
11375 This option may be used as 'server' setting to reset any 'disabled'
11376 setting which would have been inherited from 'default-server' directive as
11377 default value.
11378 It may also be used as 'default-server' setting to reset any previous
11379 'default-server' 'disabled' setting.
Willy Tarreau96839092010-03-29 10:02:24 +020011380
Krzysztof Piotr Oledzkic53601c2010-01-06 10:50:42 +010011381error-limit <count>
Willy Tarreau983e01e2010-01-11 18:42:06 +010011382 If health observing is enabled, the "error-limit" parameter specifies the
11383 number of consecutive errors that triggers event selected by the "on-error"
11384 option. By default it is set to 10 consecutive errors.
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +010011385
Krzysztof Piotr Oledzkic53601c2010-01-06 10:50:42 +010011386 See also the "check", "error-limit" and "on-error".
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +010011387
Krzysztof Piotr Oledzkic53601c2010-01-06 10:50:42 +010011388fall <count>
Willy Tarreauc57f0e22009-05-10 13:12:33 +020011389 The "fall" parameter states that a server will be considered as dead after
11390 <count> consecutive unsuccessful health checks. This value defaults to 3 if
11391 unspecified. See also the "check", "inter" and "rise" parameters.
11392
Emeric Brun8694b9a2012-10-05 14:39:07 +020011393force-sslv3
11394 This option enforces use of SSLv3 only when SSL is used to communicate with
11395 the server. SSLv3 is generally less expensive than the TLS counterparts for
Emeric Brun2c86cbf2014-10-30 15:56:50 +010011396 high connection rates. This option is also available on global statement
Emmanuel Hocdete1c722b2017-03-31 15:02:54 +020011397 "ssl-default-server-options". See also "ssl-min-ver" and ssl-max-ver".
Emeric Brun8694b9a2012-10-05 14:39:07 +020011398
11399force-tlsv10
11400 This option enforces use of TLSv1.0 only when SSL is used to communicate with
Emeric Brun2c86cbf2014-10-30 15:56:50 +010011401 the server. This option is also available on global statement
Emmanuel Hocdete1c722b2017-03-31 15:02:54 +020011402 "ssl-default-server-options". See also "ssl-min-ver" and ssl-max-ver".
Emeric Brun8694b9a2012-10-05 14:39:07 +020011403
11404force-tlsv11
11405 This option enforces use of TLSv1.1 only when SSL is used to communicate with
Emeric Brun2c86cbf2014-10-30 15:56:50 +010011406 the server. This option is also available on global statement
Emmanuel Hocdete1c722b2017-03-31 15:02:54 +020011407 "ssl-default-server-options". See also "ssl-min-ver" and ssl-max-ver".
Emeric Brun8694b9a2012-10-05 14:39:07 +020011408
11409force-tlsv12
11410 This option enforces use of TLSv1.2 only when SSL is used to communicate with
Emeric Brun2c86cbf2014-10-30 15:56:50 +010011411 the server. This option is also available on global statement
Emmanuel Hocdete1c722b2017-03-31 15:02:54 +020011412 "ssl-default-server-options". See also "ssl-min-ver" and ssl-max-ver".
Emeric Brun8694b9a2012-10-05 14:39:07 +020011413
Emmanuel Hocdet42fb9802017-03-30 19:29:39 +020011414force-tlsv13
11415 This option enforces use of TLSv1.3 only when SSL is used to communicate with
11416 the server. This option is also available on global statement
Emmanuel Hocdete1c722b2017-03-31 15:02:54 +020011417 "ssl-default-server-options". See also "ssl-min-ver" and ssl-max-ver".
Emmanuel Hocdet42fb9802017-03-30 19:29:39 +020011418
Willy Tarreauc57f0e22009-05-10 13:12:33 +020011419id <value>
Willy Tarreau53fb4ae2009-10-04 23:04:08 +020011420 Set a persistent ID for the server. This ID must be positive and unique for
11421 the proxy. An unused ID will automatically be assigned if unset. The first
11422 assigned value will be 1. This ID is currently only returned in statistics.
Willy Tarreauc57f0e22009-05-10 13:12:33 +020011423
Willy Tarreau6a031d12016-11-07 19:42:35 +010011424init-addr {last | libc | none | <ip>},[...]*
11425 Indicate in what order the server's address should be resolved upon startup
11426 if it uses an FQDN. Attempts are made to resolve the address by applying in
Davor Ocelice9ed2812017-12-25 17:49:28 +010011427 turn each of the methods mentioned in the comma-delimited list. The first
Willy Tarreau6a031d12016-11-07 19:42:35 +010011428 method which succeeds is used. If the end of the list is reached without
11429 finding a working method, an error is thrown. Method "last" suggests to pick
11430 the address which appears in the state file (see "server-state-file"). Method
11431 "libc" uses the libc's internal resolver (gethostbyname() or getaddrinfo()
11432 depending on the operating system and build options). Method "none"
11433 specifically indicates that the server should start without any valid IP
11434 address in a down state. It can be useful to ignore some DNS issues upon
11435 startup, waiting for the situation to get fixed later. Finally, an IP address
11436 (IPv4 or IPv6) may be provided. It can be the currently known address of the
Davor Ocelice9ed2812017-12-25 17:49:28 +010011437 server (e.g. filled by a configuration generator), or the address of a dummy
Willy Tarreau6a031d12016-11-07 19:42:35 +010011438 server used to catch old sessions and present them with a decent error
11439 message for example. When the "first" load balancing algorithm is used, this
11440 IP address could point to a fake server used to trigger the creation of new
11441 instances on the fly. This option defaults to "last,libc" indicating that the
11442 previous address found in the state file (if any) is used first, otherwise
11443 the libc's resolver is used. This ensures continued compatibility with the
Davor Ocelice9ed2812017-12-25 17:49:28 +010011444 historic behavior.
Willy Tarreau6a031d12016-11-07 19:42:35 +010011445
11446 Example:
11447 defaults
11448 # never fail on address resolution
11449 default-server init-addr last,libc,none
11450
Krzysztof Piotr Oledzkic53601c2010-01-06 10:50:42 +010011451inter <delay>
11452fastinter <delay>
11453downinter <delay>
Willy Tarreauc57f0e22009-05-10 13:12:33 +020011454 The "inter" parameter sets the interval between two consecutive health checks
11455 to <delay> milliseconds. If left unspecified, the delay defaults to 2000 ms.
11456 It is also possible to use "fastinter" and "downinter" to optimize delays
11457 between checks depending on the server state :
11458
Pieter Baauw44fc9df2015-09-17 21:30:46 +020011459 Server state | Interval used
11460 ----------------------------------------+----------------------------------
11461 UP 100% (non-transitional) | "inter"
11462 ----------------------------------------+----------------------------------
11463 Transitionally UP (going down "fall"), | "fastinter" if set,
11464 Transitionally DOWN (going up "rise"), | "inter" otherwise.
11465 or yet unchecked. |
11466 ----------------------------------------+----------------------------------
11467 DOWN 100% (non-transitional) | "downinter" if set,
11468 | "inter" otherwise.
11469 ----------------------------------------+----------------------------------
Willy Tarreaud72758d2010-01-12 10:42:19 +010011470
Willy Tarreauc57f0e22009-05-10 13:12:33 +020011471 Just as with every other time-based parameter, they can be entered in any
11472 other explicit unit among { us, ms, s, m, h, d }. The "inter" parameter also
11473 serves as a timeout for health checks sent to servers if "timeout check" is
11474 not set. In order to reduce "resonance" effects when multiple servers are
Simon Hormand60d6912013-11-25 10:46:36 +090011475 hosted on the same hardware, the agent and health checks of all servers
11476 are started with a small time offset between them. It is also possible to
11477 add some random noise in the agent and health checks interval using the
11478 global "spread-checks" keyword. This makes sense for instance when a lot
11479 of backends use the same servers.
Willy Tarreauc57f0e22009-05-10 13:12:33 +020011480
Krzysztof Piotr Oledzkic53601c2010-01-06 10:50:42 +010011481maxconn <maxconn>
Willy Tarreauc57f0e22009-05-10 13:12:33 +020011482 The "maxconn" parameter specifies the maximal number of concurrent
11483 connections that will be sent to this server. If the number of incoming
11484 concurrent requests goes higher than this value, they will be queued, waiting
11485 for a connection to be released. This parameter is very important as it can
11486 save fragile servers from going down under extreme loads. If a "minconn"
11487 parameter is specified, the limit becomes dynamic. The default value is "0"
11488 which means unlimited. See also the "minconn" and "maxqueue" parameters, and
11489 the backend's "fullconn" keyword.
11490
Krzysztof Piotr Oledzkic53601c2010-01-06 10:50:42 +010011491maxqueue <maxqueue>
Willy Tarreauc57f0e22009-05-10 13:12:33 +020011492 The "maxqueue" parameter specifies the maximal number of connections which
11493 will wait in the queue for this server. If this limit is reached, next
11494 requests will be redispatched to other servers instead of indefinitely
11495 waiting to be served. This will break persistence but may allow people to
11496 quickly re-log in when the server they try to connect to is dying. The
11497 default value is "0" which means the queue is unlimited. See also the
11498 "maxconn" and "minconn" parameters.
11499
Krzysztof Piotr Oledzkic53601c2010-01-06 10:50:42 +010011500minconn <minconn>
Willy Tarreauc57f0e22009-05-10 13:12:33 +020011501 When the "minconn" parameter is set, the maxconn limit becomes a dynamic
11502 limit following the backend's load. The server will always accept at least
11503 <minconn> connections, never more than <maxconn>, and the limit will be on
11504 the ramp between both values when the backend has less than <fullconn>
11505 concurrent connections. This makes it possible to limit the load on the
11506 server during normal loads, but push it further for important loads without
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +010011507 overloading the server during exceptional loads. See also the "maxconn"
Willy Tarreauc57f0e22009-05-10 13:12:33 +020011508 and "maxqueue" parameters, as well as the "fullconn" backend keyword.
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +010011509
Willy Tarreaud72f0f32015-10-13 14:50:22 +020011510namespace <name>
11511 On Linux, it is possible to specify which network namespace a socket will
11512 belong to. This directive makes it possible to explicitly bind a server to
11513 a namespace different from the default one. Please refer to your operating
11514 system's documentation to find more details about network namespaces.
11515
Frédéric Lécailled2376272017-03-21 18:52:12 +010011516no-agent-check
11517 This option may be used as "server" setting to reset any "agent-check"
11518 setting which would have been inherited from "default-server" directive as
11519 default value.
11520 It may also be used as "default-server" setting to reset any previous
11521 "default-server" "agent-check" setting.
11522
11523no-backup
11524 This option may be used as "server" setting to reset any "backup"
11525 setting which would have been inherited from "default-server" directive as
11526 default value.
11527 It may also be used as "default-server" setting to reset any previous
11528 "default-server" "backup" setting.
11529
11530no-check
11531 This option may be used as "server" setting to reset any "check"
11532 setting which would have been inherited from "default-server" directive as
11533 default value.
11534 It may also be used as "default-server" setting to reset any previous
11535 "default-server" "check" setting.
11536
11537no-check-ssl
11538 This option may be used as "server" setting to reset any "check-ssl"
11539 setting which would have been inherited from "default-server" directive as
11540 default value.
11541 It may also be used as "default-server" setting to reset any previous
11542 "default-server" "check-ssl" setting.
11543
Frédéric Lécailled2376272017-03-21 18:52:12 +010011544no-send-proxy
11545 This option may be used as "server" setting to reset any "send-proxy"
11546 setting which would have been inherited from "default-server" directive as
11547 default value.
11548 It may also be used as "default-server" setting to reset any previous
11549 "default-server" "send-proxy" setting.
11550
11551no-send-proxy-v2
11552 This option may be used as "server" setting to reset any "send-proxy-v2"
11553 setting which would have been inherited from "default-server" directive as
11554 default value.
11555 It may also be used as "default-server" setting to reset any previous
11556 "default-server" "send-proxy-v2" setting.
11557
11558no-send-proxy-v2-ssl
11559 This option may be used as "server" setting to reset any "send-proxy-v2-ssl"
11560 setting which would have been inherited from "default-server" directive as
11561 default value.
11562 It may also be used as "default-server" setting to reset any previous
11563 "default-server" "send-proxy-v2-ssl" setting.
11564
11565no-send-proxy-v2-ssl-cn
11566 This option may be used as "server" setting to reset any "send-proxy-v2-ssl-cn"
11567 setting which would have been inherited from "default-server" directive as
11568 default value.
11569 It may also be used as "default-server" setting to reset any previous
11570 "default-server" "send-proxy-v2-ssl-cn" setting.
11571
11572no-ssl
11573 This option may be used as "server" setting to reset any "ssl"
11574 setting which would have been inherited from "default-server" directive as
11575 default value.
11576 It may also be used as "default-server" setting to reset any previous
11577 "default-server" "ssl" setting.
11578
Willy Tarreau2a3fb1c2015-02-05 16:47:07 +010011579no-ssl-reuse
11580 This option disables SSL session reuse when SSL is used to communicate with
11581 the server. It will force the server to perform a full handshake for every
11582 new connection. It's probably only useful for benchmarking, troubleshooting,
11583 and for paranoid users.
11584
Emeric Brun9b3009b2012-10-05 11:55:06 +020011585no-sslv3
Willy Tarreaua0ee1d02012-09-10 09:01:23 +020011586 This option disables support for SSLv3 when SSL is used to communicate with
11587 the server. Note that SSLv2 is disabled in the code and cannot be enabled
Emmanuel Hocdete1c722b2017-03-31 15:02:54 +020011588 using any configuration option. Use "ssl-min-ver" and "ssl-max-ver" instead.
Willy Tarreaua0ee1d02012-09-10 09:01:23 +020011589
Emmanuel Hocdet6cb2d1e2017-03-30 14:43:31 +020011590 Supported in default-server: No
11591
Emeric Brunf9c5c472012-10-11 15:28:34 +020011592no-tls-tickets
11593 This setting is only available when support for OpenSSL was built in. It
11594 disables the stateless session resumption (RFC 5077 TLS Ticket
11595 extension) and force to use stateful session resumption. Stateless
Emeric Brun2c86cbf2014-10-30 15:56:50 +010011596 session resumption is more expensive in CPU usage for servers. This option
11597 is also available on global statement "ssl-default-server-options".
Frédéric Lécailled2376272017-03-21 18:52:12 +010011598 See also "tls-tickets".
Emeric Brunf9c5c472012-10-11 15:28:34 +020011599
Emeric Brun9b3009b2012-10-05 11:55:06 +020011600no-tlsv10
Emeric Brun8694b9a2012-10-05 14:39:07 +020011601 This option disables support for TLSv1.0 when SSL is used to communicate with
Emeric Brunf5da4932012-09-28 19:42:54 +020011602 the server. Note that SSLv2 is disabled in the code and cannot be enabled
11603 using any configuration option. TLSv1 is more expensive than SSLv3 so it
Emeric Brun2c86cbf2014-10-30 15:56:50 +010011604 often makes sense to disable it when communicating with local servers. This
11605 option is also available on global statement "ssl-default-server-options".
Emmanuel Hocdete1c722b2017-03-31 15:02:54 +020011606 Use "ssl-min-ver" and "ssl-max-ver" instead.
Willy Tarreau763a95b2012-10-04 23:15:39 +020011607
Emmanuel Hocdet6cb2d1e2017-03-30 14:43:31 +020011608 Supported in default-server: No
11609
Emeric Brun9b3009b2012-10-05 11:55:06 +020011610no-tlsv11
Emeric Brun8694b9a2012-10-05 14:39:07 +020011611 This option disables support for TLSv1.1 when SSL is used to communicate with
Emeric Brunf5da4932012-09-28 19:42:54 +020011612 the server. Note that SSLv2 is disabled in the code and cannot be enabled
11613 using any configuration option. TLSv1 is more expensive than SSLv3 so it
Emeric Brun2c86cbf2014-10-30 15:56:50 +010011614 often makes sense to disable it when communicating with local servers. This
11615 option is also available on global statement "ssl-default-server-options".
Emmanuel Hocdete1c722b2017-03-31 15:02:54 +020011616 Use "ssl-min-ver" and "ssl-max-ver" instead.
Willy Tarreau763a95b2012-10-04 23:15:39 +020011617
Emmanuel Hocdet6cb2d1e2017-03-30 14:43:31 +020011618 Supported in default-server: No
11619
Emeric Brun9b3009b2012-10-05 11:55:06 +020011620no-tlsv12
Emeric Brun8694b9a2012-10-05 14:39:07 +020011621 This option disables support for TLSv1.2 when SSL is used to communicate with
Willy Tarreaua0ee1d02012-09-10 09:01:23 +020011622 the server. Note that SSLv2 is disabled in the code and cannot be enabled
11623 using any configuration option. TLSv1 is more expensive than SSLv3 so it
Emeric Brun2c86cbf2014-10-30 15:56:50 +010011624 often makes sense to disable it when communicating with local servers. This
11625 option is also available on global statement "ssl-default-server-options".
Emmanuel Hocdete1c722b2017-03-31 15:02:54 +020011626 Use "ssl-min-ver" and "ssl-max-ver" instead.
Emmanuel Hocdet42fb9802017-03-30 19:29:39 +020011627
11628 Supported in default-server: No
11629
11630no-tlsv13
11631 This option disables support for TLSv1.3 when SSL is used to communicate with
11632 the server. Note that SSLv2 is disabled in the code and cannot be enabled
11633 using any configuration option. TLSv1 is more expensive than SSLv3 so it
11634 often makes sense to disable it when communicating with local servers. This
11635 option is also available on global statement "ssl-default-server-options".
Emmanuel Hocdete1c722b2017-03-31 15:02:54 +020011636 Use "ssl-min-ver" and "ssl-max-ver" instead.
Willy Tarreaua0ee1d02012-09-10 09:01:23 +020011637
Emmanuel Hocdet6cb2d1e2017-03-30 14:43:31 +020011638 Supported in default-server: No
11639
Frédéric Lécailled2376272017-03-21 18:52:12 +010011640no-verifyhost
11641 This option may be used as "server" setting to reset any "verifyhost"
11642 setting which would have been inherited from "default-server" directive as
11643 default value.
11644 It may also be used as "default-server" setting to reset any previous
11645 "default-server" "verifyhost" setting.
Willy Tarreau763a95b2012-10-04 23:15:39 +020011646
Simon Hormanfa461682011-06-25 09:39:49 +090011647non-stick
11648 Never add connections allocated to this sever to a stick-table.
11649 This may be used in conjunction with backup to ensure that
11650 stick-table persistence is disabled for backup servers.
11651
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +010011652observe <mode>
11653 This option enables health adjusting based on observing communication with
11654 the server. By default this functionality is disabled and enabling it also
11655 requires to enable health checks. There are two supported modes: "layer4" and
11656 "layer7". In layer4 mode, only successful/unsuccessful tcp connections are
11657 significant. In layer7, which is only allowed for http proxies, responses
11658 received from server are verified, like valid/wrong http code, unparsable
Willy Tarreau150d1462012-03-10 08:19:02 +010011659 headers, a timeout, etc. Valid status codes include 100 to 499, 501 and 505.
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +010011660
11661 See also the "check", "on-error" and "error-limit".
11662
Krzysztof Piotr Oledzkic53601c2010-01-06 10:50:42 +010011663on-error <mode>
Krzysztof Piotr Oledzki97f07b82009-12-15 22:31:24 +010011664 Select what should happen when enough consecutive errors are detected.
11665 Currently, four modes are available:
11666 - fastinter: force fastinter
11667 - fail-check: simulate a failed check, also forces fastinter (default)
11668 - sudden-death: simulate a pre-fatal failed health check, one more failed
11669 check will mark a server down, forces fastinter
11670 - mark-down: mark the server immediately down and force fastinter
11671
11672 See also the "check", "observe" and "error-limit".
11673
Simon Hormane0d1bfb2011-06-21 14:34:58 +090011674on-marked-down <action>
11675 Modify what occurs when a server is marked down.
11676 Currently one action is available:
Justin Karnegeseb2c24a2012-05-24 15:28:52 -070011677 - shutdown-sessions: Shutdown peer sessions. When this setting is enabled,
11678 all connections to the server are immediately terminated when the server
11679 goes down. It might be used if the health check detects more complex cases
11680 than a simple connection status, and long timeouts would cause the service
11681 to remain unresponsive for too long a time. For instance, a health check
11682 might detect that a database is stuck and that there's no chance to reuse
11683 existing connections anymore. Connections killed this way are logged with
11684 a 'D' termination code (for "Down").
Simon Hormane0d1bfb2011-06-21 14:34:58 +090011685
11686 Actions are disabled by default
11687
Justin Karnegeseb2c24a2012-05-24 15:28:52 -070011688on-marked-up <action>
11689 Modify what occurs when a server is marked up.
11690 Currently one action is available:
11691 - shutdown-backup-sessions: Shutdown sessions on all backup servers. This is
11692 done only if the server is not in backup state and if it is not disabled
11693 (it must have an effective weight > 0). This can be used sometimes to force
11694 an active server to take all the traffic back after recovery when dealing
Davor Ocelice9ed2812017-12-25 17:49:28 +010011695 with long sessions (e.g. LDAP, SQL, ...). Doing this can cause more trouble
11696 than it tries to solve (e.g. incomplete transactions), so use this feature
Justin Karnegeseb2c24a2012-05-24 15:28:52 -070011697 with extreme care. Sessions killed because a server comes up are logged
11698 with an 'U' termination code (for "Up").
11699
11700 Actions are disabled by default
11701
Krzysztof Piotr Oledzkic53601c2010-01-06 10:50:42 +010011702port <port>
Willy Tarreauc57f0e22009-05-10 13:12:33 +020011703 Using the "port" parameter, it becomes possible to use a different port to
11704 send health-checks. On some servers, it may be desirable to dedicate a port
11705 to a specific component able to perform complex tests which are more suitable
11706 to health-checks than the application. It is common to run a simple script in
11707 inetd for instance. This parameter is ignored if the "check" parameter is not
11708 set. See also the "addr" parameter.
11709
Christopher Faulet8ed0a3e2018-04-10 14:45:45 +020011710proto <name>
11711
11712 Forces the multiplexer's protocol to use for the outgoing connections to this
11713 server. It must be compatible with the mode of the backend (TCP or HTTP). It
11714 must also be usable on the backend side. The list of available protocols is
11715 reported in haproxy -vv.
11716 Idea behind this optipon is to bypass the selection of the best multiplexer's
11717 protocol for all connections established to this server.
11718
Willy Tarreauc57f0e22009-05-10 13:12:33 +020011719redir <prefix>
11720 The "redir" parameter enables the redirection mode for all GET and HEAD
11721 requests addressing this server. This means that instead of having HAProxy
11722 forward the request to the server, it will send an "HTTP 302" response with
11723 the "Location" header composed of this prefix immediately followed by the
11724 requested URI beginning at the leading '/' of the path component. That means
11725 that no trailing slash should be used after <prefix>. All invalid requests
11726 will be rejected, and all non-GET or HEAD requests will be normally served by
11727 the server. Note that since the response is completely forged, no header
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +010011728 mangling nor cookie insertion is possible in the response. However, cookies in
Davor Ocelice9ed2812017-12-25 17:49:28 +010011729 requests are still analyzed, making this solution completely usable to direct
Willy Tarreauc57f0e22009-05-10 13:12:33 +020011730 users to a remote location in case of local disaster. Main use consists in
11731 increasing bandwidth for static servers by having the clients directly
11732 connect to them. Note: never use a relative location here, it would cause a
11733 loop between the client and HAProxy!
11734
11735 Example : server srv1 192.168.1.1:80 redir http://image1.mydomain.com check
11736
Krzysztof Piotr Oledzkic53601c2010-01-06 10:50:42 +010011737rise <count>
Willy Tarreauc57f0e22009-05-10 13:12:33 +020011738 The "rise" parameter states that a server will be considered as operational
11739 after <count> consecutive successful health checks. This value defaults to 2
11740 if unspecified. See also the "check", "inter" and "fall" parameters.
11741
Baptiste Assmann8e2d9432018-06-22 15:04:43 +020011742resolve-opts <option>,<option>,...
11743 Comma separated list of options to apply to DNS resolution linked to this
11744 server.
11745
11746 Available options:
11747
11748 * allow-dup-ip
11749 By default, HAProxy prevents IP address duplication in a backend when DNS
11750 resolution at runtime is in operation.
11751 That said, for some cases, it makes sense that two servers (in the same
11752 backend, being resolved by the same FQDN) have the same IP address.
11753 For such case, simply enable this option.
11754 This is the opposite of prevent-dup-ip.
11755
11756 * prevent-dup-ip
11757 Ensure HAProxy's default behavior is enforced on a server: prevent re-using
11758 an IP address already set to a server in the same backend and sharing the
11759 same fqdn.
11760 This is the opposite of allow-dup-ip.
11761
11762 Example:
11763 backend b_myapp
11764 default-server init-addr none resolvers dns
11765 server s1 myapp.example.com:80 check resolve-opts allow-dup-ip
11766 server s2 myapp.example.com:81 check resolve-opts allow-dup-ip
11767
11768 With the option allow-dup-ip set:
11769 * if the nameserver returns a single IP address, then both servers will use
11770 it
11771 * If the nameserver returns 2 IP addresses, then each server will pick up a
11772 different address
11773
11774 Default value: not set
11775
Baptiste Assmann1fa66662015-04-14 00:28:47 +020011776resolve-prefer <family>
11777 When DNS resolution is enabled for a server and multiple IP addresses from
11778 different families are returned, HAProxy will prefer using an IP address
11779 from the family mentioned in the "resolve-prefer" parameter.
11780 Available families: "ipv4" and "ipv6"
11781
Baptiste Assmannc4aabae2015-08-04 22:43:06 +020011782 Default value: ipv6
11783
Olivier Doucetaa1ea8a2016-08-05 17:15:20 +020011784 Example:
11785
11786 server s1 app1.domain.com:80 resolvers mydns resolve-prefer ipv6
Baptiste Assmann1fa66662015-04-14 00:28:47 +020011787
Thierry Fournierac88cfe2016-02-17 22:05:30 +010011788resolve-net <network>[,<network[,...]]
11789 This options prioritize th choice of an ip address matching a network. This is
11790 useful with clouds to prefer a local ip. In some cases, a cloud high
Tim Düsterhus4896c442016-11-29 02:15:19 +010011791 availability service can be announced with many ip addresses on many
Davor Ocelice9ed2812017-12-25 17:49:28 +010011792 different datacenters. The latency between datacenter is not negligible, so
11793 this patch permits to prefer a local datacenter. If no address matches the
Thierry Fournierac88cfe2016-02-17 22:05:30 +010011794 configured network, another address is selected.
11795
Olivier Doucetaa1ea8a2016-08-05 17:15:20 +020011796 Example:
11797
11798 server s1 app1.domain.com:80 resolvers mydns resolve-net 10.0.0.0/8
Thierry Fournierac88cfe2016-02-17 22:05:30 +010011799
Baptiste Assmann1fa66662015-04-14 00:28:47 +020011800resolvers <id>
11801 Points to an existing "resolvers" section to resolve current server's
11802 hostname.
11803
Olivier Doucetaa1ea8a2016-08-05 17:15:20 +020011804 Example:
11805
11806 server s1 app1.domain.com:80 check resolvers mydns
Baptiste Assmann1fa66662015-04-14 00:28:47 +020011807
Olivier Doucetaa1ea8a2016-08-05 17:15:20 +020011808 See also section 5.3
Baptiste Assmann1fa66662015-04-14 00:28:47 +020011809
Willy Tarreau5ab04ec2011-03-20 10:32:26 +010011810send-proxy
11811 The "send-proxy" parameter enforces use of the PROXY protocol over any
11812 connection established to this server. The PROXY protocol informs the other
11813 end about the layer 3/4 addresses of the incoming connection, so that it can
11814 know the client's address or the public address it accessed to, whatever the
Bertrand Jacquin93b227d2016-06-04 15:11:10 +010011815 upper layer protocol. For connections accepted by an "accept-proxy" or
11816 "accept-netscaler-cip" listener, the advertised address will be used. Only
11817 TCPv4 and TCPv6 address families are supported. Other families such as
11818 Unix sockets, will report an UNKNOWN family. Servers using this option can
11819 fully be chained to another instance of haproxy listening with an
11820 "accept-proxy" setting. This setting must not be used if the server isn't
11821 aware of the protocol. When health checks are sent to the server, the PROXY
11822 protocol is automatically used when this option is set, unless there is an
11823 explicit "port" or "addr" directive, in which case an explicit
11824 "check-send-proxy" directive would also be needed to use the PROXY protocol.
Frédéric Lécailled2376272017-03-21 18:52:12 +010011825 See also the "no-send-proxy" option of this section and "accept-proxy" and
11826 "accept-netscaler-cip" option of the "bind" keyword.
Willy Tarreau5ab04ec2011-03-20 10:32:26 +010011827
David Safb76832014-05-08 23:42:08 -040011828send-proxy-v2
11829 The "send-proxy-v2" parameter enforces use of the PROXY protocol version 2
11830 over any connection established to this server. The PROXY protocol informs
11831 the other end about the layer 3/4 addresses of the incoming connection, so
11832 that it can know the client's address or the public address it accessed to,
Emmanuel Hocdet404d9782017-10-24 10:55:14 +020011833 whatever the upper layer protocol. It also send ALPN information if an alpn
11834 have been negotiated. This setting must not be used if the server isn't aware
11835 of this version of the protocol. See also the "no-send-proxy-v2" option of
11836 this section and send-proxy" option of the "bind" keyword.
David Safb76832014-05-08 23:42:08 -040011837
Emmanuel Hocdetf643b802018-02-01 15:20:32 +010011838proxy-v2-options <option>[,<option>]*
11839 The "proxy-v2-options" parameter add option to send in PROXY protocol version
11840 2 when "send-proxy-v2" is used. Options available are "ssl" (see also
Emmanuel Hocdetfa8d0f12018-02-01 15:53:52 +010011841 send-proxy-v2-ssl), "cert-cn" (see also "send-proxy-v2-ssl-cn"), "ssl-cipher":
11842 name of the used cipher, "cert-sig": signature algorithm of the used
Emmanuel Hocdet253c3b72018-02-01 18:29:59 +010011843 certificate, "cert-key": key algorithm of the used certificate), "authority":
11844 host name value passed by the client (only sni from a tls connection is
Emmanuel Hocdet4399c752018-02-05 15:26:43 +010011845 supported), "crc32c": checksum of the proxy protocol v2 header.
Emmanuel Hocdetf643b802018-02-01 15:20:32 +010011846
David Safb76832014-05-08 23:42:08 -040011847send-proxy-v2-ssl
11848 The "send-proxy-v2-ssl" parameter enforces use of the PROXY protocol version
11849 2 over any connection established to this server. The PROXY protocol informs
11850 the other end about the layer 3/4 addresses of the incoming connection, so
11851 that it can know the client's address or the public address it accessed to,
11852 whatever the upper layer protocol. In addition, the SSL information extension
11853 of the PROXY protocol is added to the PROXY protocol header. This setting
11854 must not be used if the server isn't aware of this version of the protocol.
Frédéric Lécailled2376272017-03-21 18:52:12 +010011855 See also the "no-send-proxy-v2-ssl" option of this section and the
11856 "send-proxy-v2" option of the "bind" keyword.
David Safb76832014-05-08 23:42:08 -040011857
11858send-proxy-v2-ssl-cn
11859 The "send-proxy-v2-ssl" parameter enforces use of the PROXY protocol version
11860 2 over any connection established to this server. The PROXY protocol informs
11861 the other end about the layer 3/4 addresses of the incoming connection, so
11862 that it can know the client's address or the public address it accessed to,
11863 whatever the upper layer protocol. In addition, the SSL information extension
11864 of the PROXY protocol, along along with the Common Name from the subject of
11865 the client certificate (if any), is added to the PROXY protocol header. This
11866 setting must not be used if the server isn't aware of this version of the
Davor Ocelice9ed2812017-12-25 17:49:28 +010011867 protocol. See also the "no-send-proxy-v2-ssl-cn" option of this section and
11868 the "send-proxy-v2" option of the "bind" keyword.
David Safb76832014-05-08 23:42:08 -040011869
Krzysztof Piotr Oledzkic53601c2010-01-06 10:50:42 +010011870slowstart <start_time_in_ms>
Willy Tarreauc57f0e22009-05-10 13:12:33 +020011871 The "slowstart" parameter for a server accepts a value in milliseconds which
11872 indicates after how long a server which has just come back up will run at
11873 full speed. Just as with every other time-based parameter, it can be entered
11874 in any other explicit unit among { us, ms, s, m, h, d }. The speed grows
11875 linearly from 0 to 100% during this time. The limitation applies to two
11876 parameters :
11877
11878 - maxconn: the number of connections accepted by the server will grow from 1
11879 to 100% of the usual dynamic limit defined by (minconn,maxconn,fullconn).
11880
11881 - weight: when the backend uses a dynamic weighted algorithm, the weight
11882 grows linearly from 1 to 100%. In this case, the weight is updated at every
11883 health-check. For this reason, it is important that the "inter" parameter
11884 is smaller than the "slowstart", in order to maximize the number of steps.
11885
11886 The slowstart never applies when haproxy starts, otherwise it would cause
11887 trouble to running servers. It only applies when a server has been previously
11888 seen as failed.
11889
Willy Tarreau732eac42015-07-09 11:40:25 +020011890sni <expression>
11891 The "sni" parameter evaluates the sample fetch expression, converts it to a
11892 string and uses the result as the host name sent in the SNI TLS extension to
11893 the server. A typical use case is to send the SNI received from the client in
11894 a bridged HTTPS scenario, using the "ssl_fc_sni" sample fetch for the
Willy Tarreau2ab88672017-07-05 18:23:03 +020011895 expression, though alternatives such as req.hdr(host) can also make sense. If
11896 "verify required" is set (which is the recommended setting), the resulting
Willy Tarreauad92a9a2017-07-28 11:38:41 +020011897 name will also be matched against the server certificate's names. See the
11898 "verify" directive for more details.
Willy Tarreau732eac42015-07-09 11:40:25 +020011899
Willy Tarreauc6f4ce82009-06-10 11:09:37 +020011900source <addr>[:<pl>[-<ph>]] [usesrc { <addr2>[:<port2>] | client | clientip } ]
Willy Tarreaubce70882009-09-07 11:51:47 +020011901source <addr>[:<port>] [usesrc { <addr2>[:<port2>] | hdr_ip(<hdr>[,<occ>]) } ]
Willy Tarreauc6f4ce82009-06-10 11:09:37 +020011902source <addr>[:<pl>[-<ph>]] [interface <name>] ...
Willy Tarreauc57f0e22009-05-10 13:12:33 +020011903 The "source" parameter sets the source address which will be used when
11904 connecting to the server. It follows the exact same parameters and principle
11905 as the backend "source" keyword, except that it only applies to the server
11906 referencing it. Please consult the "source" keyword for details.
11907
Willy Tarreauc6f4ce82009-06-10 11:09:37 +020011908 Additionally, the "source" statement on a server line allows one to specify a
11909 source port range by indicating the lower and higher bounds delimited by a
11910 dash ('-'). Some operating systems might require a valid IP address when a
11911 source port range is specified. It is permitted to have the same IP/range for
11912 several servers. Doing so makes it possible to bypass the maximum of 64k
11913 total concurrent connections. The limit will then reach 64k connections per
11914 server.
11915
Lukas Tribus7d56c6d2016-09-13 09:51:15 +000011916 Since Linux 4.2/libc 2.23 IP_BIND_ADDRESS_NO_PORT is set for connections
11917 specifying the source address without port(s).
11918
Willy Tarreaua0ee1d02012-09-10 09:01:23 +020011919ssl
Willy Tarreau44f65392013-06-25 07:56:20 +020011920 This option enables SSL ciphering on outgoing connections to the server. It
11921 is critical to verify server certificates using "verify" when using SSL to
11922 connect to servers, otherwise the communication is prone to trivial man in
11923 the-middle attacks rendering SSL useless. When this option is used, health
11924 checks are automatically sent in SSL too unless there is a "port" or an
11925 "addr" directive indicating the check should be sent to a different location.
Frédéric Lécailled2376272017-03-21 18:52:12 +010011926 See the "no-ssl" to disable "ssl" option and "check-ssl" option to force
11927 SSL health checks.
Willy Tarreau763a95b2012-10-04 23:15:39 +020011928
Emmanuel Hocdete1c722b2017-03-31 15:02:54 +020011929ssl-max-ver [ SSLv3 | TLSv1.0 | TLSv1.1 | TLSv1.2 | TLSv1.3 ]
11930 This option enforces use of <version> or lower when SSL is used to communicate
11931 with the server. This option is also available on global statement
11932 "ssl-default-server-options". See also "ssl-min-ver".
11933
11934ssl-min-ver [ SSLv3 | TLSv1.0 | TLSv1.1 | TLSv1.2 | TLSv1.3 ]
11935 This option enforces use of <version> or upper when SSL is used to communicate
11936 with the server. This option is also available on global statement
11937 "ssl-default-server-options". See also "ssl-max-ver".
11938
Frédéric Lécailled2376272017-03-21 18:52:12 +010011939ssl-reuse
11940 This option may be used as "server" setting to reset any "no-ssl-reuse"
11941 setting which would have been inherited from "default-server" directive as
11942 default value.
11943 It may also be used as "default-server" setting to reset any previous
11944 "default-server" "no-ssl-reuse" setting.
11945
11946stick
11947 This option may be used as "server" setting to reset any "non-stick"
11948 setting which would have been inherited from "default-server" directive as
11949 default value.
11950 It may also be used as "default-server" setting to reset any previous
11951 "default-server" "non-stick" setting.
Willy Tarreaua0ee1d02012-09-10 09:01:23 +020011952
Willy Tarreau163d4622015-10-13 16:16:41 +020011953tcp-ut <delay>
11954 Sets the TCP User Timeout for all outgoing connections to this server. This
11955 option is available on Linux since version 2.6.37. It allows haproxy to
11956 configure a timeout for sockets which contain data not receiving an
Davor Ocelice9ed2812017-12-25 17:49:28 +010011957 acknowledgment for the configured delay. This is especially useful on
Willy Tarreau163d4622015-10-13 16:16:41 +020011958 long-lived connections experiencing long idle periods such as remote
11959 terminals or database connection pools, where the client and server timeouts
11960 must remain high to allow a long period of idle, but where it is important to
11961 detect that the server has disappeared in order to release all resources
11962 associated with its connection (and the client's session). One typical use
11963 case is also to force dead server connections to die when health checks are
11964 too slow or during a soft reload since health checks are then disabled. The
11965 argument is a delay expressed in milliseconds by default. This only works for
11966 regular TCP connections, and is ignored for other protocols.
11967
Willy Tarreauc57f0e22009-05-10 13:12:33 +020011968track [<proxy>/]<server>
Willy Tarreau32091232014-05-16 13:52:00 +020011969 This option enables ability to set the current state of the server by tracking
11970 another one. It is possible to track a server which itself tracks another
11971 server, provided that at the end of the chain, a server has health checks
11972 enabled. If <proxy> is omitted the current one is used. If disable-on-404 is
Willy Tarreauc57f0e22009-05-10 13:12:33 +020011973 used, it has to be enabled on both proxies.
11974
Frédéric Lécailled2376272017-03-21 18:52:12 +010011975tls-tickets
11976 This option may be used as "server" setting to reset any "no-tls-tickets"
11977 setting which would have been inherited from "default-server" directive as
11978 default value.
11979 It may also be used as "default-server" setting to reset any previous
11980 "default-server" "no-tlsv-tickets" setting.
Krzysztof Piotr Oledzkic53601c2010-01-06 10:50:42 +010011981
Emeric Brunef42d922012-10-11 16:11:36 +020011982verify [none|required]
11983 This setting is only available when support for OpenSSL was built in. If set
Emeric Brun850efd52014-01-29 12:24:34 +010011984 to 'none', server certificate is not verified. In the other case, The
Willy Tarreauad92a9a2017-07-28 11:38:41 +020011985 certificate provided by the server is verified using CAs from 'ca-file' and
11986 optional CRLs from 'crl-file' after having checked that the names provided in
Davor Ocelice9ed2812017-12-25 17:49:28 +010011987 the certificate's subject and subjectAlternateNames attributes match either
Willy Tarreauad92a9a2017-07-28 11:38:41 +020011988 the name passed using the "sni" directive, or if not provided, the static
11989 host name passed using the "verifyhost" directive. When no name is found, the
11990 certificate's names are ignored. For this reason, without SNI it's important
11991 to use "verifyhost". On verification failure the handshake is aborted. It is
11992 critically important to verify server certificates when using SSL to connect
11993 to servers, otherwise the communication is prone to trivial man-in-the-middle
11994 attacks rendering SSL totally useless. Unless "ssl_server_verify" appears in
11995 the global section, "verify" is set to "required" by default.
Emeric Brunef42d922012-10-11 16:11:36 +020011996
Evan Broderbe554312013-06-27 00:05:25 -070011997verifyhost <hostname>
11998 This setting is only available when support for OpenSSL was built in, and
Willy Tarreauad92a9a2017-07-28 11:38:41 +020011999 only takes effect if 'verify required' is also specified. This directive sets
12000 a default static hostname to check the server's certificate against when no
12001 SNI was used to connect to the server. If SNI is not used, this is the only
12002 way to enable hostname verification. This static hostname, when set, will
12003 also be used for health checks (which cannot provide an SNI value). If none
12004 of the hostnames in the certificate match the specified hostname, the
12005 handshake is aborted. The hostnames in the server-provided certificate may
12006 include wildcards. See also "verify", "sni" and "no-verifyhost" options.
Evan Broderbe554312013-06-27 00:05:25 -070012007
Krzysztof Piotr Oledzkic53601c2010-01-06 10:50:42 +010012008weight <weight>
Willy Tarreauc57f0e22009-05-10 13:12:33 +020012009 The "weight" parameter is used to adjust the server's weight relative to
12010 other servers. All servers will receive a load proportional to their weight
12011 relative to the sum of all weights, so the higher the weight, the higher the
Willy Tarreau6704d672009-06-15 10:56:05 +020012012 load. The default weight is 1, and the maximal value is 256. A value of 0
12013 means the server will not participate in load-balancing but will still accept
12014 persistent connections. If this parameter is used to distribute the load
12015 according to server's capacity, it is recommended to start with values which
12016 can both grow and shrink, for instance between 10 and 100 to leave enough
12017 room above and below for later adjustments.
Willy Tarreauc57f0e22009-05-10 13:12:33 +020012018
12019
Cyril Bonté46175dd2015-07-02 22:45:32 +0200120205.3. Server IP address resolution using DNS
12021-------------------------------------------
Baptiste Assmann1fa66662015-04-14 00:28:47 +020012022
Baptiste Assmann62b75b42015-09-09 01:11:36 +020012023HAProxy allows using a host name on the server line to retrieve its IP address
12024using name servers. By default, HAProxy resolves the name when parsing the
12025configuration file, at startup and cache the result for the process' life.
Baptiste Assmann1fa66662015-04-14 00:28:47 +020012026This is not sufficient in some cases, such as in Amazon where a server's IP
12027can change after a reboot or an ELB Virtual IP can change based on current
12028workload.
12029This chapter describes how HAProxy can be configured to process server's name
12030resolution at run time.
12031Whether run time server name resolution has been enable or not, HAProxy will
12032carry on doing the first resolution when parsing the configuration.
12033
12034
Cyril Bonté46175dd2015-07-02 22:45:32 +0200120355.3.1. Global overview
12036----------------------
Baptiste Assmann1fa66662015-04-14 00:28:47 +020012037
12038As we've seen in introduction, name resolution in HAProxy occurs at two
12039different steps of the process life:
12040
12041 1. when starting up, HAProxy parses the server line definition and matches a
12042 host name. It uses libc functions to get the host name resolved. This
12043 resolution relies on /etc/resolv.conf file.
12044
Christopher Faulet67957bd2017-09-27 11:00:59 +020012045 2. at run time, HAProxy performs periodically name resolutions for servers
12046 requiring DNS resolutions.
Baptiste Assmann1fa66662015-04-14 00:28:47 +020012047
12048A few other events can trigger a name resolution at run time:
12049 - when a server's health check ends up in a connection timeout: this may be
12050 because the server has a new IP address. So we need to trigger a name
12051 resolution to know this new IP.
12052
Christopher Faulet67957bd2017-09-27 11:00:59 +020012053When using resolvers, the server name can either be a hostname, or a SRV label.
Davor Ocelice9ed2812017-12-25 17:49:28 +010012054HAProxy considers anything that starts with an underscore as a SRV label. If a
Christopher Faulet67957bd2017-09-27 11:00:59 +020012055SRV label is specified, then the corresponding SRV records will be retrieved
12056from the DNS server, and the provided hostnames will be used. The SRV label
12057will be checked periodically, and if any server are added or removed, haproxy
12058will automatically do the same.
Olivier Houchardecfa18d2017-08-07 17:30:03 +020012059
Baptiste Assmann1fa66662015-04-14 00:28:47 +020012060A few things important to notice:
12061 - all the name servers are queried in the mean time. HAProxy will process the
12062 first valid response.
12063
12064 - a resolution is considered as invalid (NX, timeout, refused), when all the
12065 servers return an error.
12066
12067
Cyril Bonté46175dd2015-07-02 22:45:32 +0200120685.3.2. The resolvers section
12069----------------------------
Baptiste Assmann1fa66662015-04-14 00:28:47 +020012070
12071This section is dedicated to host information related to name resolution in
Christopher Faulet67957bd2017-09-27 11:00:59 +020012072HAProxy. There can be as many as resolvers section as needed. Each section can
12073contain many name servers.
Baptiste Assmann1fa66662015-04-14 00:28:47 +020012074
Baptiste Assmann62b75b42015-09-09 01:11:36 +020012075When multiple name servers are configured in a resolvers section, then HAProxy
12076uses the first valid response. In case of invalid responses, only the last one
12077is treated. Purpose is to give the chance to a slow server to deliver a valid
12078answer after a fast faulty or outdated server.
12079
12080When each server returns a different error type, then only the last error is
Christopher Faulet67957bd2017-09-27 11:00:59 +020012081used by HAProxy. The following processing is applied on this error:
Baptiste Assmann62b75b42015-09-09 01:11:36 +020012082
Christopher Faulet67957bd2017-09-27 11:00:59 +020012083 1. HAProxy retries the same DNS query with a new query type. The A queries are
12084 switch to AAAA or the opposite. SRV queries are not concerned here. Timeout
12085 errors are also excluded.
Baptiste Assmann62b75b42015-09-09 01:11:36 +020012086
Christopher Faulet67957bd2017-09-27 11:00:59 +020012087 2. When the fallback on the query type was done (or not applicable), HAProxy
12088 retries the original DNS query, with the preferred query type.
Baptiste Assmann62b75b42015-09-09 01:11:36 +020012089
Christopher Faulet67957bd2017-09-27 11:00:59 +020012090 3. HAProxy retries previous steps <resolve_retires> times. If no valid
12091 response is received after that, it stops the DNS resolution and reports
12092 the error.
Baptiste Assmann62b75b42015-09-09 01:11:36 +020012093
Christopher Faulet67957bd2017-09-27 11:00:59 +020012094For example, with 2 name servers configured in a resolvers section, the
12095following scenarios are possible:
12096
12097 - First response is valid and is applied directly, second response is
12098 ignored
12099
12100 - First response is invalid and second one is valid, then second response is
12101 applied
12102
12103 - First response is a NX domain and second one a truncated response, then
12104 HAProxy retries the query with a new type
12105
12106 - First response is a NX domain and second one is a timeout, then HAProxy
12107 retries the query with a new type
12108
12109 - Query timed out for both name servers, then HAProxy retries it with the
12110 same query type
Baptiste Assmann62b75b42015-09-09 01:11:36 +020012111
Olivier Houcharda8c6db82017-07-06 18:46:47 +020012112As a DNS server may not answer all the IPs in one DNS request, haproxy keeps
12113a cache of previous answers, an answer will be considered obsolete after
Christopher Faulet67957bd2017-09-27 11:00:59 +020012114<hold obsolete> seconds without the IP returned.
Olivier Houcharda8c6db82017-07-06 18:46:47 +020012115
Baptiste Assmann62b75b42015-09-09 01:11:36 +020012116
Baptiste Assmann1fa66662015-04-14 00:28:47 +020012117resolvers <resolvers id>
Davor Ocelice9ed2812017-12-25 17:49:28 +010012118 Creates a new name server list labeled <resolvers id>
Baptiste Assmann1fa66662015-04-14 00:28:47 +020012119
12120A resolvers section accept the following parameters:
12121
Baptiste Assmann2af08fe2017-08-14 00:13:01 +020012122accepted_payload_size <nb>
Davor Ocelice9ed2812017-12-25 17:49:28 +010012123 Defines the maximum payload size accepted by HAProxy and announced to all the
Christopher Faulet67957bd2017-09-27 11:00:59 +020012124 name servers configured in this resolvers section.
Baptiste Assmann2af08fe2017-08-14 00:13:01 +020012125 <nb> is in bytes. If not set, HAProxy announces 512. (minimal value defined
12126 by RFC 6891)
12127
Baptiste Assmann9d8dbbc2017-08-18 23:35:08 +020012128 Note: the maximum allowed value is 8192.
12129
Baptiste Assmann1fa66662015-04-14 00:28:47 +020012130nameserver <id> <ip>:<port>
12131 DNS server description:
12132 <id> : label of the server, should be unique
12133 <ip> : IP address of the server
12134 <port> : port where the DNS service actually runs
12135
Ben Draut44e609b2018-05-29 15:40:08 -060012136parse-resolv-conf
12137 Adds all nameservers found in /etc/resolv.conf to this resolvers nameservers
12138 list. Ordered as if each nameserver in /etc/resolv.conf was individually
12139 placed in the resolvers section in place of this directive.
12140
Baptiste Assmann1fa66662015-04-14 00:28:47 +020012141hold <status> <period>
12142 Defines <period> during which the last name resolution should be kept based
12143 on last resolution <status>
Baptiste Assmann987e16d2016-11-02 22:23:31 +010012144 <status> : last name resolution status. Acceptable values are "nx",
Olivier Houcharda8c6db82017-07-06 18:46:47 +020012145 "other", "refused", "timeout", "valid", "obsolete".
Baptiste Assmann1fa66662015-04-14 00:28:47 +020012146 <period> : interval between two successive name resolution when the last
12147 answer was in <status>. It follows the HAProxy time format.
12148 <period> is in milliseconds by default.
12149
Baptiste Assmann686408b2017-08-18 10:15:42 +020012150 Default value is 10s for "valid", 0s for "obsolete" and 30s for others.
Baptiste Assmann1fa66662015-04-14 00:28:47 +020012151
Christopher Faulet67957bd2017-09-27 11:00:59 +020012152resolution_pool_size <nb> (deprecated)
Baptiste Assmann201c07f2017-05-22 15:17:15 +020012153 Defines the number of resolutions available in the pool for this resolvers.
12154 If not defines, it defaults to 64. If your configuration requires more than
12155 <nb>, then HAProxy will return an error when parsing the configuration.
12156
Baptiste Assmann1fa66662015-04-14 00:28:47 +020012157resolve_retries <nb>
12158 Defines the number <nb> of queries to send to resolve a server name before
12159 giving up.
12160 Default value: 3
12161
Baptiste Assmann62b75b42015-09-09 01:11:36 +020012162 A retry occurs on name server timeout or when the full sequence of DNS query
12163 type failover is over and we need to start up from the default ANY query
12164 type.
12165
Baptiste Assmann1fa66662015-04-14 00:28:47 +020012166timeout <event> <time>
12167 Defines timeouts related to name resolution
12168 <event> : the event on which the <time> timeout period applies to.
12169 events available are:
Christopher Faulet67957bd2017-09-27 11:00:59 +020012170 - resolve : default time to trigger name resolutions when no
12171 other time applied.
12172 Default value: 1s
12173 - retry : time between two DNS queries, when no valid response
12174 have been received.
12175 Default value: 1s
Baptiste Assmann1fa66662015-04-14 00:28:47 +020012176 <time> : time related to the event. It follows the HAProxy time format.
12177 <time> is expressed in milliseconds.
12178
Olivier Doucetaa1ea8a2016-08-05 17:15:20 +020012179 Example:
Baptiste Assmann1fa66662015-04-14 00:28:47 +020012180
12181 resolvers mydns
12182 nameserver dns1 10.0.0.1:53
12183 nameserver dns2 10.0.0.2:53
Ben Draut44e609b2018-05-29 15:40:08 -060012184 parse-resolv-conf
Baptiste Assmann1fa66662015-04-14 00:28:47 +020012185 resolve_retries 3
Christopher Faulet67957bd2017-09-27 11:00:59 +020012186 timeout resolve 1s
Baptiste Assmann1fa66662015-04-14 00:28:47 +020012187 timeout retry 1s
Baptiste Assmann987e16d2016-11-02 22:23:31 +010012188 hold other 30s
12189 hold refused 30s
12190 hold nx 30s
12191 hold timeout 30s
Baptiste Assmann1fa66662015-04-14 00:28:47 +020012192 hold valid 10s
Olivier Houcharda8c6db82017-07-06 18:46:47 +020012193 hold obsolete 30s
Baptiste Assmann1fa66662015-04-14 00:28:47 +020012194
12195
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200121966. HTTP header manipulation
12197---------------------------
12198
12199In HTTP mode, it is possible to rewrite, add or delete some of the request and
12200response headers based on regular expressions. It is also possible to block a
12201request or a response if a particular header matches a regular expression,
12202which is enough to stop most elementary protocol attacks, and to protect
Willy Tarreau70dffda2014-01-30 03:07:23 +010012203against information leak from the internal network.
Willy Tarreauc57f0e22009-05-10 13:12:33 +020012204
Willy Tarreau70dffda2014-01-30 03:07:23 +010012205If HAProxy encounters an "Informational Response" (status code 1xx), it is able
12206to process all rsp* rules which can allow, deny, rewrite or delete a header,
12207but it will refuse to add a header to any such messages as this is not
12208HTTP-compliant. The reason for still processing headers in such responses is to
12209stop and/or fix any possible information leak which may happen, for instance
12210because another downstream equipment would unconditionally add a header, or if
12211a server name appears there. When such messages are seen, normal processing
12212still occurs on the next non-informational messages.
Willy Tarreau816b9792009-09-15 21:25:21 +020012213
Willy Tarreauc57f0e22009-05-10 13:12:33 +020012214This section covers common usage of the following keywords, described in detail
12215in section 4.2 :
12216
12217 - reqadd <string>
12218 - reqallow <search>
12219 - reqiallow <search>
12220 - reqdel <search>
12221 - reqidel <search>
12222 - reqdeny <search>
12223 - reqideny <search>
12224 - reqpass <search>
12225 - reqipass <search>
12226 - reqrep <search> <replace>
12227 - reqirep <search> <replace>
12228 - reqtarpit <search>
12229 - reqitarpit <search>
12230 - rspadd <string>
12231 - rspdel <search>
12232 - rspidel <search>
12233 - rspdeny <search>
12234 - rspideny <search>
12235 - rsprep <search> <replace>
12236 - rspirep <search> <replace>
12237
12238With all these keywords, the same conventions are used. The <search> parameter
12239is a POSIX extended regular expression (regex) which supports grouping through
12240parenthesis (without the backslash). Spaces and other delimiters must be
12241prefixed with a backslash ('\') to avoid confusion with a field delimiter.
12242Other characters may be prefixed with a backslash to change their meaning :
12243
12244 \t for a tab
12245 \r for a carriage return (CR)
12246 \n for a new line (LF)
12247 \ to mark a space and differentiate it from a delimiter
12248 \# to mark a sharp and differentiate it from a comment
12249 \\ to use a backslash in a regex
12250 \\\\ to use a backslash in the text (*2 for regex, *2 for haproxy)
12251 \xXX to write the ASCII hex code XX as in the C language
12252
12253The <replace> parameter contains the string to be used to replace the largest
12254portion of text matching the regex. It can make use of the special characters
12255above, and can reference a substring which is delimited by parenthesis in the
12256regex, by writing a backslash ('\') immediately followed by one digit from 0 to
122579 indicating the group position (0 designating the entire line). This practice
12258is very common to users of the "sed" program.
12259
12260The <string> parameter represents the string which will systematically be added
12261after the last header line. It can also use special character sequences above.
12262
12263Notes related to these keywords :
12264---------------------------------
12265 - these keywords are not always convenient to allow/deny based on header
12266 contents. It is strongly recommended to use ACLs with the "block" keyword
12267 instead, resulting in far more flexible and manageable rules.
12268
12269 - lines are always considered as a whole. It is not possible to reference
12270 a header name only or a value only. This is important because of the way
12271 headers are written (notably the number of spaces after the colon).
12272
12273 - the first line is always considered as a header, which makes it possible to
12274 rewrite or filter HTTP requests URIs or response codes, but in turn makes
12275 it harder to distinguish between headers and request line. The regex prefix
12276 ^[^\ \t]*[\ \t] matches any HTTP method followed by a space, and the prefix
12277 ^[^ \t:]*: matches any header name followed by a colon.
12278
12279 - for performances reasons, the number of characters added to a request or to
12280 a response is limited at build time to values between 1 and 4 kB. This
12281 should normally be far more than enough for most usages. If it is too short
12282 on occasional usages, it is possible to gain some space by removing some
12283 useless headers before adding new ones.
12284
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +010012285 - keywords beginning with "reqi" and "rspi" are the same as their counterpart
Willy Tarreauc57f0e22009-05-10 13:12:33 +020012286 without the 'i' letter except that they ignore case when matching patterns.
12287
12288 - when a request passes through a frontend then a backend, all req* rules
12289 from the frontend will be evaluated, then all req* rules from the backend
12290 will be evaluated. The reverse path is applied to responses.
12291
12292 - req* statements are applied after "block" statements, so that "block" is
12293 always the first one, but before "use_backend" in order to permit rewriting
Willy Tarreaud72758d2010-01-12 10:42:19 +010012294 before switching.
Willy Tarreauc57f0e22009-05-10 13:12:33 +020012295
12296
Willy Tarreau74ca5042013-06-11 23:12:07 +0200122977. Using ACLs and fetching samples
12298----------------------------------
12299
Davor Ocelice9ed2812017-12-25 17:49:28 +010012300HAProxy is capable of extracting data from request or response streams, from
Willy Tarreau74ca5042013-06-11 23:12:07 +020012301client or server information, from tables, environmental information etc...
12302The action of extracting such data is called fetching a sample. Once retrieved,
12303these samples may be used for various purposes such as a key to a stick-table,
12304but most common usages consist in matching them against predefined constant
12305data called patterns.
12306
12307
123087.1. ACL basics
12309---------------
Willy Tarreauc57f0e22009-05-10 13:12:33 +020012310
12311The use of Access Control Lists (ACL) provides a flexible solution to perform
12312content switching and generally to take decisions based on content extracted
12313from the request, the response or any environmental status. The principle is
12314simple :
12315
Willy Tarreau74ca5042013-06-11 23:12:07 +020012316 - extract a data sample from a stream, table or the environment
Willy Tarreaue6b11e42013-11-26 19:02:32 +010012317 - optionally apply some format conversion to the extracted sample
Willy Tarreau74ca5042013-06-11 23:12:07 +020012318 - apply one or multiple pattern matching methods on this sample
12319 - perform actions only when a pattern matches the sample
Willy Tarreauc57f0e22009-05-10 13:12:33 +020012320
Willy Tarreau74ca5042013-06-11 23:12:07 +020012321The actions generally consist in blocking a request, selecting a backend, or
12322adding a header.
Willy Tarreauc57f0e22009-05-10 13:12:33 +020012323
12324In order to define a test, the "acl" keyword is used. The syntax is :
12325
Willy Tarreau74ca5042013-06-11 23:12:07 +020012326 acl <aclname> <criterion> [flags] [operator] [<value>] ...
Willy Tarreauc57f0e22009-05-10 13:12:33 +020012327
12328This creates a new ACL <aclname> or completes an existing one with new tests.
12329Those tests apply to the portion of request/response specified in <criterion>
12330and may be adjusted with optional flags [flags]. Some criteria also support
Willy Tarreaue6b11e42013-11-26 19:02:32 +010012331an operator which may be specified before the set of values. Optionally some
12332conversion operators may be applied to the sample, and they will be specified
12333as a comma-delimited list of keywords just after the first keyword. The values
12334are of the type supported by the criterion, and are separated by spaces.
Willy Tarreauc57f0e22009-05-10 13:12:33 +020012335
12336ACL names must be formed from upper and lower case letters, digits, '-' (dash),
12337'_' (underscore) , '.' (dot) and ':' (colon). ACL names are case-sensitive,
12338which means that "my_acl" and "My_Acl" are two different ACLs.
12339
12340There is no enforced limit to the number of ACLs. The unused ones do not affect
12341performance, they just consume a small amount of memory.
12342
Willy Tarreau74ca5042013-06-11 23:12:07 +020012343The criterion generally is the name of a sample fetch method, or one of its ACL
12344specific declinations. The default test method is implied by the output type of
12345this sample fetch method. The ACL declinations can describe alternate matching
Willy Tarreaue6b11e42013-11-26 19:02:32 +010012346methods of a same sample fetch method. The sample fetch methods are the only
12347ones supporting a conversion.
Willy Tarreau74ca5042013-06-11 23:12:07 +020012348
12349Sample fetch methods return data which can be of the following types :
12350 - boolean
12351 - integer (signed or unsigned)
12352 - IPv4 or IPv6 address
12353 - string
12354 - data block
12355
Willy Tarreaue6b11e42013-11-26 19:02:32 +010012356Converters transform any of these data into any of these. For example, some
12357converters might convert a string to a lower-case string while other ones
12358would turn a string to an IPv4 address, or apply a netmask to an IP address.
12359The resulting sample is of the type of the last converter applied to the list,
12360which defaults to the type of the sample fetch method.
12361
Thierry FOURNIER2a06e392014-05-11 15:49:55 +020012362Each sample or converter returns data of a specific type, specified with its
12363keyword in this documentation. When an ACL is declared using a standard sample
12364fetch method, certain types automatically involved a default matching method
12365which are summarized in the table below :
12366
12367 +---------------------+-----------------+
12368 | Sample or converter | Default |
12369 | output type | matching method |
12370 +---------------------+-----------------+
12371 | boolean | bool |
12372 +---------------------+-----------------+
12373 | integer | int |
12374 +---------------------+-----------------+
12375 | ip | ip |
12376 +---------------------+-----------------+
12377 | string | str |
12378 +---------------------+-----------------+
12379 | binary | none, use "-m" |
12380 +---------------------+-----------------+
12381
12382Note that in order to match a binary samples, it is mandatory to specify a
12383matching method, see below.
12384
Willy Tarreau74ca5042013-06-11 23:12:07 +020012385The ACL engine can match these types against patterns of the following types :
12386 - boolean
12387 - integer or integer range
12388 - IP address / network
12389 - string (exact, substring, suffix, prefix, subdir, domain)
12390 - regular expression
12391 - hex block
12392
Willy Tarreauc57f0e22009-05-10 13:12:33 +020012393The following ACL flags are currently supported :
12394
Willy Tarreau2b5285d2010-05-09 23:45:24 +020012395 -i : ignore case during matching of all subsequent patterns.
12396 -f : load patterns from a file.
Willy Tarreau74ca5042013-06-11 23:12:07 +020012397 -m : use a specific pattern matching method
Thierry FOURNIERb7729c92014-02-11 16:24:41 +010012398 -n : forbid the DNS resolutions
Thierry FOURNIER9860c412014-01-29 14:23:29 +010012399 -M : load the file pointed by -f like a map file.
Thierry FOURNIER3534d882014-01-20 17:01:44 +010012400 -u : force the unique id of the ACL
Willy Tarreau6a06a402007-07-15 20:15:28 +020012401 -- : force end of flags. Useful when a string looks like one of the flags.
12402
Willy Tarreau74ca5042013-06-11 23:12:07 +020012403The "-f" flag is followed by the name of a file from which all lines will be
12404read as individual values. It is even possible to pass multiple "-f" arguments
12405if the patterns are to be loaded from multiple files. Empty lines as well as
12406lines beginning with a sharp ('#') will be ignored. All leading spaces and tabs
12407will be stripped. If it is absolutely necessary to insert a valid pattern
12408beginning with a sharp, just prefix it with a space so that it is not taken for
12409a comment. Depending on the data type and match method, haproxy may load the
12410lines into a binary tree, allowing very fast lookups. This is true for IPv4 and
12411exact string matching. In this case, duplicates will automatically be removed.
12412
Thierry FOURNIER9860c412014-01-29 14:23:29 +010012413The "-M" flag allows an ACL to use a map file. If this flag is set, the file is
12414parsed as two column file. The first column contains the patterns used by the
12415ACL, and the second column contain the samples. The sample can be used later by
12416a map. This can be useful in some rare cases where an ACL would just be used to
12417check for the existence of a pattern in a map before a mapping is applied.
12418
Thierry FOURNIER3534d882014-01-20 17:01:44 +010012419The "-u" flag forces the unique id of the ACL. This unique id is used with the
12420socket interface to identify ACL and dynamically change its values. Note that a
12421file is always identified by its name even if an id is set.
12422
Willy Tarreau74ca5042013-06-11 23:12:07 +020012423Also, note that the "-i" flag applies to subsequent entries and not to entries
12424loaded from files preceding it. For instance :
12425
12426 acl valid-ua hdr(user-agent) -f exact-ua.lst -i -f generic-ua.lst test
12427
12428In this example, each line of "exact-ua.lst" will be exactly matched against
12429the "user-agent" header of the request. Then each line of "generic-ua" will be
12430case-insensitively matched. Then the word "test" will be insensitively matched
12431as well.
12432
12433The "-m" flag is used to select a specific pattern matching method on the input
12434sample. All ACL-specific criteria imply a pattern matching method and generally
12435do not need this flag. However, this flag is useful with generic sample fetch
12436methods to describe how they're going to be matched against the patterns. This
12437is required for sample fetches which return data type for which there is no
Davor Ocelice9ed2812017-12-25 17:49:28 +010012438obvious matching method (e.g. string or binary). When "-m" is specified and
Willy Tarreau74ca5042013-06-11 23:12:07 +020012439followed by a pattern matching method name, this method is used instead of the
12440default one for the criterion. This makes it possible to match contents in ways
12441that were not initially planned, or with sample fetch methods which return a
12442string. The matching method also affects the way the patterns are parsed.
12443
Thierry FOURNIERb7729c92014-02-11 16:24:41 +010012444The "-n" flag forbids the dns resolutions. It is used with the load of ip files.
12445By default, if the parser cannot parse ip address it considers that the parsed
12446string is maybe a domain name and try dns resolution. The flag "-n" disable this
12447resolution. It is useful for detecting malformed ip lists. Note that if the DNS
12448server is not reachable, the haproxy configuration parsing may last many minutes
12449waiting fir the timeout. During this time no error messages are displayed. The
12450flag "-n" disable this behavior. Note also that during the runtime, this
12451function is disabled for the dynamic acl modifications.
12452
Willy Tarreau74ca5042013-06-11 23:12:07 +020012453There are some restrictions however. Not all methods can be used with all
12454sample fetch methods. Also, if "-m" is used in conjunction with "-f", it must
12455be placed first. The pattern matching method must be one of the following :
Willy Tarreau5adeda12013-03-31 22:13:34 +020012456
12457 - "found" : only check if the requested sample could be found in the stream,
12458 but do not compare it against any pattern. It is recommended not
Willy Tarreau74ca5042013-06-11 23:12:07 +020012459 to pass any pattern to avoid confusion. This matching method is
12460 particularly useful to detect presence of certain contents such
12461 as headers, cookies, etc... even if they are empty and without
12462 comparing them to anything nor counting them.
Willy Tarreau5adeda12013-03-31 22:13:34 +020012463
12464 - "bool" : check the value as a boolean. It can only be applied to fetches
12465 which return a boolean or integer value, and takes no pattern.
Willy Tarreau74ca5042013-06-11 23:12:07 +020012466 Value zero or false does not match, all other values do match.
Willy Tarreau5adeda12013-03-31 22:13:34 +020012467
12468 - "int" : match the value as an integer. It can be used with integer and
Willy Tarreau74ca5042013-06-11 23:12:07 +020012469 boolean samples. Boolean false is integer 0, true is integer 1.
Willy Tarreau5adeda12013-03-31 22:13:34 +020012470
12471 - "ip" : match the value as an IPv4 or IPv6 address. It is compatible
Willy Tarreau74ca5042013-06-11 23:12:07 +020012472 with IP address samples only, so it is implied and never needed.
Willy Tarreau5adeda12013-03-31 22:13:34 +020012473
Davor Ocelice9ed2812017-12-25 17:49:28 +010012474 - "bin" : match the contents against a hexadecimal string representing a
Willy Tarreau5adeda12013-03-31 22:13:34 +020012475 binary sequence. This may be used with binary or string samples.
12476
12477 - "len" : match the sample's length as an integer. This may be used with
12478 binary or string samples.
12479
Willy Tarreau74ca5042013-06-11 23:12:07 +020012480 - "str" : exact match : match the contents against a string. This may be
12481 used with binary or string samples.
Willy Tarreau5adeda12013-03-31 22:13:34 +020012482
Willy Tarreau74ca5042013-06-11 23:12:07 +020012483 - "sub" : substring match : check that the contents contain at least one of
12484 the provided string patterns. This may be used with binary or
12485 string samples.
Willy Tarreau5adeda12013-03-31 22:13:34 +020012486
Willy Tarreau74ca5042013-06-11 23:12:07 +020012487 - "reg" : regex match : match the contents against a list of regular
12488 expressions. This may be used with binary or string samples.
Willy Tarreau5adeda12013-03-31 22:13:34 +020012489
Willy Tarreau74ca5042013-06-11 23:12:07 +020012490 - "beg" : prefix match : check that the contents begin like the provided
12491 string patterns. This may be used with binary or string samples.
Willy Tarreau5adeda12013-03-31 22:13:34 +020012492
Willy Tarreau74ca5042013-06-11 23:12:07 +020012493 - "end" : suffix match : check that the contents end like the provided
12494 string patterns. This may be used with binary or string samples.
Willy Tarreau5adeda12013-03-31 22:13:34 +020012495
Willy Tarreau74ca5042013-06-11 23:12:07 +020012496 - "dir" : subdir match : check that a slash-delimited portion of the
12497 contents exactly matches one of the provided string patterns.
Willy Tarreau5adeda12013-03-31 22:13:34 +020012498 This may be used with binary or string samples.
12499
Willy Tarreau74ca5042013-06-11 23:12:07 +020012500 - "dom" : domain match : check that a dot-delimited portion of the contents
12501 exactly match one of the provided string patterns. This may be
12502 used with binary or string samples.
Willy Tarreau5adeda12013-03-31 22:13:34 +020012503
12504For example, to quickly detect the presence of cookie "JSESSIONID" in an HTTP
12505request, it is possible to do :
12506
12507 acl jsess_present cook(JSESSIONID) -m found
12508
12509In order to apply a regular expression on the 500 first bytes of data in the
12510buffer, one would use the following acl :
12511
12512 acl script_tag payload(0,500) -m reg -i <script>
12513
Willy Tarreaue6b11e42013-11-26 19:02:32 +010012514On systems where the regex library is much slower when using "-i", it is
12515possible to convert the sample to lowercase before matching, like this :
12516
12517 acl script_tag payload(0,500),lower -m reg <script>
12518
Willy Tarreau74ca5042013-06-11 23:12:07 +020012519All ACL-specific criteria imply a default matching method. Most often, these
12520criteria are composed by concatenating the name of the original sample fetch
12521method and the matching method. For example, "hdr_beg" applies the "beg" match
12522to samples retrieved using the "hdr" fetch method. Since all ACL-specific
12523criteria rely on a sample fetch method, it is always possible instead to use
12524the original sample fetch method and the explicit matching method using "-m".
Willy Tarreau2b5285d2010-05-09 23:45:24 +020012525
Willy Tarreau74ca5042013-06-11 23:12:07 +020012526If an alternate match is specified using "-m" on an ACL-specific criterion,
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030012527the matching method is simply applied to the underlying sample fetch method.
12528For example, all ACLs below are exact equivalent :
Willy Tarreau2b5285d2010-05-09 23:45:24 +020012529
Willy Tarreau74ca5042013-06-11 23:12:07 +020012530 acl short_form hdr_beg(host) www.
12531 acl alternate1 hdr_beg(host) -m beg www.
12532 acl alternate2 hdr_dom(host) -m beg www.
12533 acl alternate3 hdr(host) -m beg www.
Willy Tarreau2b5285d2010-05-09 23:45:24 +020012534
Willy Tarreau2b5285d2010-05-09 23:45:24 +020012535
Thierry FOURNIER2a06e392014-05-11 15:49:55 +020012536The table below summarizes the compatibility matrix between sample or converter
12537types and the pattern types to fetch against. It indicates for each compatible
12538combination the name of the matching method to be used, surrounded with angle
12539brackets ">" and "<" when the method is the default one and will work by
12540default without "-m".
Willy Tarreau0ba27502007-12-24 16:55:16 +010012541
Willy Tarreau74ca5042013-06-11 23:12:07 +020012542 +-------------------------------------------------+
12543 | Input sample type |
12544 +----------------------+---------+---------+---------+---------+---------+
Thierry FOURNIER2a06e392014-05-11 15:49:55 +020012545 | pattern type | boolean | integer | ip | string | binary |
Willy Tarreau74ca5042013-06-11 23:12:07 +020012546 +----------------------+---------+---------+---------+---------+---------+
12547 | none (presence only) | found | found | found | found | found |
12548 +----------------------+---------+---------+---------+---------+---------+
Thierry FOURNIER2a06e392014-05-11 15:49:55 +020012549 | none (boolean value) |> bool <| bool | | bool | |
Willy Tarreau74ca5042013-06-11 23:12:07 +020012550 +----------------------+---------+---------+---------+---------+---------+
Thierry FOURNIER2a06e392014-05-11 15:49:55 +020012551 | integer (value) | int |> int <| int | int | |
Willy Tarreau74ca5042013-06-11 23:12:07 +020012552 +----------------------+---------+---------+---------+---------+---------+
Thierry FOURNIERe3ded592013-12-06 15:36:54 +010012553 | integer (length) | len | len | len | len | len |
Willy Tarreau74ca5042013-06-11 23:12:07 +020012554 +----------------------+---------+---------+---------+---------+---------+
Thierry FOURNIER2a06e392014-05-11 15:49:55 +020012555 | IP address | | |> ip <| ip | ip |
Willy Tarreau74ca5042013-06-11 23:12:07 +020012556 +----------------------+---------+---------+---------+---------+---------+
Thierry FOURNIER2a06e392014-05-11 15:49:55 +020012557 | exact string | str | str | str |> str <| str |
Willy Tarreau74ca5042013-06-11 23:12:07 +020012558 +----------------------+---------+---------+---------+---------+---------+
Thierry FOURNIERe3ded592013-12-06 15:36:54 +010012559 | prefix | beg | beg | beg | beg | beg |
Willy Tarreau74ca5042013-06-11 23:12:07 +020012560 +----------------------+---------+---------+---------+---------+---------+
Thierry FOURNIERe3ded592013-12-06 15:36:54 +010012561 | suffix | end | end | end | end | end |
Willy Tarreau74ca5042013-06-11 23:12:07 +020012562 +----------------------+---------+---------+---------+---------+---------+
Thierry FOURNIERe3ded592013-12-06 15:36:54 +010012563 | substring | sub | sub | sub | sub | sub |
Willy Tarreau74ca5042013-06-11 23:12:07 +020012564 +----------------------+---------+---------+---------+---------+---------+
Thierry FOURNIERe3ded592013-12-06 15:36:54 +010012565 | subdir | dir | dir | dir | dir | dir |
Willy Tarreau74ca5042013-06-11 23:12:07 +020012566 +----------------------+---------+---------+---------+---------+---------+
Thierry FOURNIERe3ded592013-12-06 15:36:54 +010012567 | domain | dom | dom | dom | dom | dom |
Willy Tarreau74ca5042013-06-11 23:12:07 +020012568 +----------------------+---------+---------+---------+---------+---------+
Thierry FOURNIERe3ded592013-12-06 15:36:54 +010012569 | regex | reg | reg | reg | reg | reg |
Willy Tarreau74ca5042013-06-11 23:12:07 +020012570 +----------------------+---------+---------+---------+---------+---------+
12571 | hex block | | | | bin | bin |
12572 +----------------------+---------+---------+---------+---------+---------+
Willy Tarreau6a06a402007-07-15 20:15:28 +020012573
12574
Willy Tarreau74ca5042013-06-11 23:12:07 +0200125757.1.1. Matching booleans
12576------------------------
12577
12578In order to match a boolean, no value is needed and all values are ignored.
12579Boolean matching is used by default for all fetch methods of type "boolean".
12580When boolean matching is used, the fetched value is returned as-is, which means
12581that a boolean "true" will always match and a boolean "false" will never match.
12582
12583Boolean matching may also be enforced using "-m bool" on fetch methods which
12584return an integer value. Then, integer value 0 is converted to the boolean
12585"false" and all other values are converted to "true".
12586
Willy Tarreau6a06a402007-07-15 20:15:28 +020012587
Willy Tarreau74ca5042013-06-11 23:12:07 +0200125887.1.2. Matching integers
12589------------------------
12590
12591Integer matching applies by default to integer fetch methods. It can also be
12592enforced on boolean fetches using "-m int". In this case, "false" is converted
12593to the integer 0, and "true" is converted to the integer 1.
12594
12595Integer matching also supports integer ranges and operators. Note that integer
12596matching only applies to positive values. A range is a value expressed with a
12597lower and an upper bound separated with a colon, both of which may be omitted.
Willy Tarreau6a06a402007-07-15 20:15:28 +020012598
12599For instance, "1024:65535" is a valid range to represent a range of
12600unprivileged ports, and "1024:" would also work. "0:1023" is a valid
12601representation of privileged ports, and ":1023" would also work.
12602
Willy Tarreau62644772008-07-16 18:36:06 +020012603As a special case, some ACL functions support decimal numbers which are in fact
12604two integers separated by a dot. This is used with some version checks for
12605instance. All integer properties apply to those decimal numbers, including
12606ranges and operators.
12607
Willy Tarreau6a06a402007-07-15 20:15:28 +020012608For an easier usage, comparison operators are also supported. Note that using
Willy Tarreau0ba27502007-12-24 16:55:16 +010012609operators with ranges does not make much sense and is strongly discouraged.
12610Similarly, it does not make much sense to perform order comparisons with a set
12611of values.
Willy Tarreau6a06a402007-07-15 20:15:28 +020012612
Willy Tarreau0ba27502007-12-24 16:55:16 +010012613Available operators for integer matching are :
Willy Tarreau6a06a402007-07-15 20:15:28 +020012614
12615 eq : true if the tested value equals at least one value
12616 ge : true if the tested value is greater than or equal to at least one value
12617 gt : true if the tested value is greater than at least one value
12618 le : true if the tested value is less than or equal to at least one value
12619 lt : true if the tested value is less than at least one value
12620
Willy Tarreau0ba27502007-12-24 16:55:16 +010012621For instance, the following ACL matches any negative Content-Length header :
Willy Tarreau6a06a402007-07-15 20:15:28 +020012622
12623 acl negative-length hdr_val(content-length) lt 0
12624
Willy Tarreau62644772008-07-16 18:36:06 +020012625This one matches SSL versions between 3.0 and 3.1 (inclusive) :
12626
12627 acl sslv3 req_ssl_ver 3:3.1
12628
Willy Tarreau6a06a402007-07-15 20:15:28 +020012629
Willy Tarreau74ca5042013-06-11 23:12:07 +0200126307.1.3. Matching strings
12631-----------------------
12632
12633String matching applies to string or binary fetch methods, and exists in 6
12634different forms :
12635
12636 - exact match (-m str) : the extracted string must exactly match the
Davor Ocelice9ed2812017-12-25 17:49:28 +010012637 patterns;
Willy Tarreau74ca5042013-06-11 23:12:07 +020012638
12639 - substring match (-m sub) : the patterns are looked up inside the
Davor Ocelice9ed2812017-12-25 17:49:28 +010012640 extracted string, and the ACL matches if any of them is found inside;
Willy Tarreau74ca5042013-06-11 23:12:07 +020012641
12642 - prefix match (-m beg) : the patterns are compared with the beginning of
12643 the extracted string, and the ACL matches if any of them matches.
12644
12645 - suffix match (-m end) : the patterns are compared with the end of the
12646 extracted string, and the ACL matches if any of them matches.
12647
Baptiste Assmann33db6002016-03-06 23:32:10 +010012648 - subdir match (-m dir) : the patterns are looked up inside the extracted
Willy Tarreau74ca5042013-06-11 23:12:07 +020012649 string, delimited with slashes ("/"), and the ACL matches if any of them
12650 matches.
12651
12652 - domain match (-m dom) : the patterns are looked up inside the extracted
12653 string, delimited with dots ("."), and the ACL matches if any of them
12654 matches.
Willy Tarreau6a06a402007-07-15 20:15:28 +020012655
12656String matching applies to verbatim strings as they are passed, with the
12657exception of the backslash ("\") which makes it possible to escape some
12658characters such as the space. If the "-i" flag is passed before the first
12659string, then the matching will be performed ignoring the case. In order
12660to match the string "-i", either set it second, or pass the "--" flag
Willy Tarreau0ba27502007-12-24 16:55:16 +010012661before the first string. Same applies of course to match the string "--".
Willy Tarreau6a06a402007-07-15 20:15:28 +020012662
12663
Willy Tarreau74ca5042013-06-11 23:12:07 +0200126647.1.4. Matching regular expressions (regexes)
12665---------------------------------------------
Willy Tarreau6a06a402007-07-15 20:15:28 +020012666
12667Just like with string matching, regex matching applies to verbatim strings as
12668they are passed, with the exception of the backslash ("\") which makes it
12669possible to escape some characters such as the space. If the "-i" flag is
12670passed before the first regex, then the matching will be performed ignoring
12671the case. In order to match the string "-i", either set it second, or pass
Willy Tarreau0ba27502007-12-24 16:55:16 +010012672the "--" flag before the first string. Same principle applies of course to
12673match the string "--".
Willy Tarreau6a06a402007-07-15 20:15:28 +020012674
12675
Willy Tarreau74ca5042013-06-11 23:12:07 +0200126767.1.5. Matching arbitrary data blocks
12677-------------------------------------
12678
12679It is possible to match some extracted samples against a binary block which may
12680not safely be represented as a string. For this, the patterns must be passed as
12681a series of hexadecimal digits in an even number, when the match method is set
12682to binary. Each sequence of two digits will represent a byte. The hexadecimal
12683digits may be used upper or lower case.
12684
12685Example :
12686 # match "Hello\n" in the input stream (\x48 \x65 \x6c \x6c \x6f \x0a)
12687 acl hello payload(0,6) -m bin 48656c6c6f0a
12688
12689
126907.1.6. Matching IPv4 and IPv6 addresses
12691---------------------------------------
Willy Tarreau6a06a402007-07-15 20:15:28 +020012692
12693IPv4 addresses values can be specified either as plain addresses or with a
12694netmask appended, in which case the IPv4 address matches whenever it is
12695within the network. Plain addresses may also be replaced with a resolvable
Willy Tarreaud2a4aa22008-01-31 15:28:22 +010012696host name, but this practice is generally discouraged as it makes it more
Willy Tarreau0ba27502007-12-24 16:55:16 +010012697difficult to read and debug configurations. If hostnames are used, you should
12698at least ensure that they are present in /etc/hosts so that the configuration
12699does not depend on any random DNS match at the moment the configuration is
12700parsed.
Willy Tarreau6a06a402007-07-15 20:15:28 +020012701
Daniel Schnellereba56342016-04-13 00:26:52 +020012702The dotted IPv4 address notation is supported in both regular as well as the
12703abbreviated form with all-0-octets omitted:
12704
12705 +------------------+------------------+------------------+
12706 | Example 1 | Example 2 | Example 3 |
12707 +------------------+------------------+------------------+
12708 | 192.168.0.1 | 10.0.0.12 | 127.0.0.1 |
12709 | 192.168.1 | 10.12 | 127.1 |
12710 | 192.168.0.1/22 | 10.0.0.12/8 | 127.0.0.1/8 |
12711 | 192.168.1/22 | 10.12/8 | 127.1/8 |
12712 +------------------+------------------+------------------+
12713
12714Notice that this is different from RFC 4632 CIDR address notation in which
12715192.168.42/24 would be equivalent to 192.168.42.0/24.
12716
Willy Tarreauceb4ac92012-04-28 00:41:46 +020012717IPv6 may be entered in their usual form, with or without a netmask appended.
12718Only bit counts are accepted for IPv6 netmasks. In order to avoid any risk of
12719trouble with randomly resolved IP addresses, host names are never allowed in
12720IPv6 patterns.
12721
12722HAProxy is also able to match IPv4 addresses with IPv6 addresses in the
12723following situations :
12724 - tested address is IPv4, pattern address is IPv4, the match applies
12725 in IPv4 using the supplied mask if any.
12726 - tested address is IPv6, pattern address is IPv6, the match applies
12727 in IPv6 using the supplied mask if any.
12728 - tested address is IPv6, pattern address is IPv4, the match applies in IPv4
12729 using the pattern's mask if the IPv6 address matches with 2002:IPV4::,
12730 ::IPV4 or ::ffff:IPV4, otherwise it fails.
12731 - tested address is IPv4, pattern address is IPv6, the IPv4 address is first
12732 converted to IPv6 by prefixing ::ffff: in front of it, then the match is
12733 applied in IPv6 using the supplied IPv6 mask.
12734
Willy Tarreau74ca5042013-06-11 23:12:07 +020012735
127367.2. Using ACLs to form conditions
12737----------------------------------
12738
12739Some actions are only performed upon a valid condition. A condition is a
12740combination of ACLs with operators. 3 operators are supported :
12741
12742 - AND (implicit)
12743 - OR (explicit with the "or" keyword or the "||" operator)
12744 - Negation with the exclamation mark ("!")
Willy Tarreau6a06a402007-07-15 20:15:28 +020012745
Willy Tarreau74ca5042013-06-11 23:12:07 +020012746A condition is formed as a disjunctive form:
Willy Tarreau6a06a402007-07-15 20:15:28 +020012747
Willy Tarreau74ca5042013-06-11 23:12:07 +020012748 [!]acl1 [!]acl2 ... [!]acln { or [!]acl1 [!]acl2 ... [!]acln } ...
Willy Tarreaubef91e72013-03-31 23:14:46 +020012749
Willy Tarreau74ca5042013-06-11 23:12:07 +020012750Such conditions are generally used after an "if" or "unless" statement,
12751indicating when the condition will trigger the action.
Willy Tarreaubef91e72013-03-31 23:14:46 +020012752
Willy Tarreau74ca5042013-06-11 23:12:07 +020012753For instance, to block HTTP requests to the "*" URL with methods other than
12754"OPTIONS", as well as POST requests without content-length, and GET or HEAD
12755requests with a content-length greater than 0, and finally every request which
12756is not either GET/HEAD/POST/OPTIONS !
12757
12758 acl missing_cl hdr_cnt(Content-length) eq 0
Jarno Huuskonen84c51ec2017-04-03 14:20:34 +030012759 http-request deny if HTTP_URL_STAR !METH_OPTIONS || METH_POST missing_cl
12760 http-request deny if METH_GET HTTP_CONTENT
12761 http-request deny unless METH_GET or METH_POST or METH_OPTIONS
Willy Tarreau74ca5042013-06-11 23:12:07 +020012762
12763To select a different backend for requests to static contents on the "www" site
12764and to every request on the "img", "video", "download" and "ftp" hosts :
12765
12766 acl url_static path_beg /static /images /img /css
12767 acl url_static path_end .gif .png .jpg .css .js
12768 acl host_www hdr_beg(host) -i www
12769 acl host_static hdr_beg(host) -i img. video. download. ftp.
12770
Davor Ocelice9ed2812017-12-25 17:49:28 +010012771 # now use backend "static" for all static-only hosts, and for static URLs
Willy Tarreau74ca5042013-06-11 23:12:07 +020012772 # of host "www". Use backend "www" for the rest.
12773 use_backend static if host_static or host_www url_static
12774 use_backend www if host_www
12775
12776It is also possible to form rules using "anonymous ACLs". Those are unnamed ACL
12777expressions that are built on the fly without needing to be declared. They must
12778be enclosed between braces, with a space before and after each brace (because
12779the braces must be seen as independent words). Example :
12780
12781 The following rule :
12782
12783 acl missing_cl hdr_cnt(Content-length) eq 0
Jarno Huuskonen84c51ec2017-04-03 14:20:34 +030012784 http-request deny if METH_POST missing_cl
Willy Tarreau74ca5042013-06-11 23:12:07 +020012785
12786 Can also be written that way :
12787
Jarno Huuskonen84c51ec2017-04-03 14:20:34 +030012788 http-request deny if METH_POST { hdr_cnt(Content-length) eq 0 }
Willy Tarreau74ca5042013-06-11 23:12:07 +020012789
12790It is generally not recommended to use this construct because it's a lot easier
12791to leave errors in the configuration when written that way. However, for very
12792simple rules matching only one source IP address for instance, it can make more
12793sense to use them than to declare ACLs with random names. Another example of
12794good use is the following :
12795
12796 With named ACLs :
12797
12798 acl site_dead nbsrv(dynamic) lt 2
12799 acl site_dead nbsrv(static) lt 2
12800 monitor fail if site_dead
12801
12802 With anonymous ACLs :
12803
12804 monitor fail if { nbsrv(dynamic) lt 2 } || { nbsrv(static) lt 2 }
12805
Jarno Huuskonen84c51ec2017-04-03 14:20:34 +030012806See section 4.2 for detailed help on the "http-request deny" and "use_backend"
12807keywords.
Willy Tarreau74ca5042013-06-11 23:12:07 +020012808
12809
128107.3. Fetching samples
12811---------------------
12812
12813Historically, sample fetch methods were only used to retrieve data to match
12814against patterns using ACLs. With the arrival of stick-tables, a new class of
12815sample fetch methods was created, most often sharing the same syntax as their
12816ACL counterpart. These sample fetch methods are also known as "fetches". As
12817of now, ACLs and fetches have converged. All ACL fetch methods have been made
12818available as fetch methods, and ACLs may use any sample fetch method as well.
12819
12820This section details all available sample fetch methods and their output type.
12821Some sample fetch methods have deprecated aliases that are used to maintain
12822compatibility with existing configurations. They are then explicitly marked as
12823deprecated and should not be used in new setups.
12824
12825The ACL derivatives are also indicated when available, with their respective
12826matching methods. These ones all have a well defined default pattern matching
12827method, so it is never necessary (though allowed) to pass the "-m" option to
12828indicate how the sample will be matched using ACLs.
12829
12830As indicated in the sample type versus matching compatibility matrix above,
12831when using a generic sample fetch method in an ACL, the "-m" option is
12832mandatory unless the sample type is one of boolean, integer, IPv4 or IPv6. When
12833the same keyword exists as an ACL keyword and as a standard fetch method, the
12834ACL engine will automatically pick the ACL-only one by default.
12835
12836Some of these keywords support one or multiple mandatory arguments, and one or
12837multiple optional arguments. These arguments are strongly typed and are checked
12838when the configuration is parsed so that there is no risk of running with an
Davor Ocelice9ed2812017-12-25 17:49:28 +010012839incorrect argument (e.g. an unresolved backend name). Fetch function arguments
12840are passed between parenthesis and are delimited by commas. When an argument
Willy Tarreau74ca5042013-06-11 23:12:07 +020012841is optional, it will be indicated below between square brackets ('[ ]'). When
12842all arguments are optional, the parenthesis may be omitted.
12843
12844Thus, the syntax of a standard sample fetch method is one of the following :
12845 - name
12846 - name(arg1)
12847 - name(arg1,arg2)
12848
Thierry FOURNIER060762e2014-04-23 13:29:15 +020012849
128507.3.1. Converters
12851-----------------
12852
Willy Tarreaue6b11e42013-11-26 19:02:32 +010012853Sample fetch methods may be combined with transformations to be applied on top
12854of the fetched sample (also called "converters"). These combinations form what
12855is called "sample expressions" and the result is a "sample". Initially this
12856was only supported by "stick on" and "stick store-request" directives but this
Davor Ocelice9ed2812017-12-25 17:49:28 +010012857has now be extended to all places where samples may be used (ACLs, log-format,
Willy Tarreaue6b11e42013-11-26 19:02:32 +010012858unique-id-format, add-header, ...).
12859
12860These transformations are enumerated as a series of specific keywords after the
12861sample fetch method. These keywords may equally be appended immediately after
12862the fetch keyword's argument, delimited by a comma. These keywords can also
Davor Ocelice9ed2812017-12-25 17:49:28 +010012863support some arguments (e.g. a netmask) which must be passed in parenthesis.
Willy Tarreau0ba27502007-12-24 16:55:16 +010012864
Willy Tarreau97707872015-01-27 15:12:13 +010012865A certain category of converters are bitwise and arithmetic operators which
12866support performing basic operations on integers. Some bitwise operations are
12867supported (and, or, xor, cpl) and some arithmetic operations are supported
12868(add, sub, mul, div, mod, neg). Some comparators are provided (odd, even, not,
12869bool) which make it possible to report a match without having to write an ACL.
12870
Willy Tarreau74ca5042013-06-11 23:12:07 +020012871The currently available list of transformation keywords include :
Willy Tarreau0ba27502007-12-24 16:55:16 +010012872
Ben Shillitof25e8e52016-12-02 14:25:37 +00001287351d.single(<prop>[,<prop>*])
12874 Returns values for the properties requested as a string, where values are
12875 separated by the delimiter specified with "51degrees-property-separator".
12876 The device is identified using the User-Agent header passed to the
12877 converter. The function can be passed up to five property names, and if a
12878 property name can't be found, the value "NoData" is returned.
12879
12880 Example :
Davor Ocelice9ed2812017-12-25 17:49:28 +010012881 # Here the header "X-51D-DeviceTypeMobileTablet" is added to the request,
12882 # containing values for the three properties requested by using the
Ben Shillitof25e8e52016-12-02 14:25:37 +000012883 # User-Agent passed to the converter.
12884 frontend http-in
12885 bind *:8081
12886 default_backend servers
12887 http-request set-header X-51D-DeviceTypeMobileTablet \
12888 %[req.fhdr(User-Agent),51d.single(DeviceType,IsMobile,IsTablet)]
12889
Willy Tarreau97707872015-01-27 15:12:13 +010012890add(<value>)
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +020012891 Adds <value> to the input value of type signed integer, and returns the
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +020012892 result as a signed integer. <value> can be a numeric value or a variable
Daniel Schneller0b547052016-03-21 20:46:57 +010012893 name. The name of the variable starts with an indication about its scope. The
12894 scopes allowed are:
Christopher Fauletff2613e2016-11-09 11:36:17 +010012895 "proc" : the variable is shared with the whole process
Daniel Schneller0b547052016-03-21 20:46:57 +010012896 "sess" : the variable is shared with the whole session
12897 "txn" : the variable is shared with the transaction (request and response)
12898 "req" : the variable is shared only during request processing
12899 "res" : the variable is shared only during response processing
Davor Ocelice9ed2812017-12-25 17:49:28 +010012900 This prefix is followed by a name. The separator is a '.'. The name may only
Christopher Fauletb71557a2016-10-31 10:49:03 +010012901 contain characters 'a-z', 'A-Z', '0-9', '.' and '_'.
Willy Tarreau97707872015-01-27 15:12:13 +010012902
12903and(<value>)
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +020012904 Performs a bitwise "AND" between <value> and the input value of type signed
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +020012905 integer, and returns the result as an signed integer. <value> can be a
Daniel Schneller0b547052016-03-21 20:46:57 +010012906 numeric value or a variable name. The name of the variable starts with an
12907 indication about its scope. The scopes allowed are:
Christopher Fauletff2613e2016-11-09 11:36:17 +010012908 "proc" : the variable is shared with the whole process
Daniel Schneller0b547052016-03-21 20:46:57 +010012909 "sess" : the variable is shared with the whole session
12910 "txn" : the variable is shared with the transaction (request and response)
12911 "req" : the variable is shared only during request processing
12912 "res" : the variable is shared only during response processing
Davor Ocelice9ed2812017-12-25 17:49:28 +010012913 This prefix is followed by a name. The separator is a '.'. The name may only
Christopher Fauletb71557a2016-10-31 10:49:03 +010012914 contain characters 'a-z', 'A-Z', '0-9', '.' and '_'.
Willy Tarreau97707872015-01-27 15:12:13 +010012915
Holger Just1bfc24b2017-05-06 00:56:53 +020012916b64dec
12917 Converts (decodes) a base64 encoded input string to its binary
12918 representation. It performs the inverse operation of base64().
12919
Emeric Brun53d1a982014-04-30 18:21:37 +020012920base64
12921 Converts a binary input sample to a base64 string. It is used to log or
Davor Ocelice9ed2812017-12-25 17:49:28 +010012922 transfer binary content in a way that can be reliably transferred (e.g.
Emeric Brun53d1a982014-04-30 18:21:37 +020012923 an SSL ID can be copied in a header).
12924
Willy Tarreau97707872015-01-27 15:12:13 +010012925bool
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +020012926 Returns a boolean TRUE if the input value of type signed integer is
Willy Tarreau97707872015-01-27 15:12:13 +010012927 non-null, otherwise returns FALSE. Used in conjunction with and(), it can be
Davor Ocelice9ed2812017-12-25 17:49:28 +010012928 used to report true/false for bit testing on input values (e.g. verify the
Willy Tarreau97707872015-01-27 15:12:13 +010012929 presence of a flag).
12930
Emeric Brun54c4ac82014-11-03 15:32:43 +010012931bytes(<offset>[,<length>])
12932 Extracts some bytes from an input binary sample. The result is a binary
12933 sample starting at an offset (in bytes) of the original sample and
Tim Düsterhus4896c442016-11-29 02:15:19 +010012934 optionally truncated at the given length.
Emeric Brun54c4ac82014-11-03 15:32:43 +010012935
Willy Tarreau280f42b2018-02-19 15:34:12 +010012936concat([<start>],[<var>],[<end>])
12937 Concatenates up to 3 fields after the current sample which is then turned to
12938 a string. The first one, <start>, is a constant string, that will be appended
12939 immediately after the existing sample. It may be omitted if not used. The
12940 second one, <var>, is a variable name. The variable will be looked up, its
12941 contents converted to a string, and it will be appended immediately after the
12942 <first> part. If the variable is not found, nothing is appended. It may be
12943 omitted as well. The third field, <end> is a constant string that will be
12944 appended after the variable. It may also be omitted. Together, these elements
12945 allow to concatenate variables with delimiters to an existing set of
12946 variables. This can be used to build new variables made of a succession of
12947 other variables, such as colon-delimited varlues. Note that due to the config
12948 parser, it is not possible to use a comma nor a closing parenthesis as
12949 delimitors.
12950
12951 Example:
12952 tcp-request session set-var(sess.src) src
12953 tcp-request session set-var(sess.dn) ssl_c_s_dn
12954 tcp-request session set-var(txn.sig) str(),concat(<ip=,sess.ip,>),concat(<dn=,sess.dn,>)
12955 http-request set-header x-hap-sig %[var(txn.sig)]
12956
Willy Tarreau97707872015-01-27 15:12:13 +010012957cpl
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +020012958 Takes the input value of type signed integer, applies a ones-complement
12959 (flips all bits) and returns the result as an signed integer.
Willy Tarreau97707872015-01-27 15:12:13 +010012960
Willy Tarreau80599772015-01-20 19:35:24 +010012961crc32([<avalanche>])
12962 Hashes a binary input sample into an unsigned 32-bit quantity using the CRC32
12963 hash function. Optionally, it is possible to apply a full avalanche hash
12964 function to the output if the optional <avalanche> argument equals 1. This
12965 converter uses the same functions as used by the various hash-based load
12966 balancing algorithms, so it will provide exactly the same results. It is
12967 provided for compatibility with other software which want a CRC32 to be
12968 computed on some input keys, so it follows the most common implementation as
12969 found in Ethernet, Gzip, PNG, etc... It is slower than the other algorithms
12970 but may provide a better or at least less predictable distribution. It must
12971 not be used for security purposes as a 32-bit hash is trivial to break. See
Emmanuel Hocdet50791a72018-03-21 11:19:01 +010012972 also "djb2", "sdbm", "wt6", "crc32c" and the "hash-type" directive.
12973
12974crc32c([<avalanche>])
12975 Hashes a binary input sample into an unsigned 32-bit quantity using the CRC32C
12976 hash function. Optionally, it is possible to apply a full avalanche hash
12977 function to the output if the optional <avalanche> argument equals 1. This
12978 converter uses the same functions as described in RFC4960, Appendix B [8].
12979 It is provided for compatibility with other software which want a CRC32C to be
12980 computed on some input keys. It is slower than the other algorithms and it must
12981 not be used for security purposes as a 32-bit hash is trivial to break. See
12982 also "djb2", "sdbm", "wt6", "crc32" and the "hash-type" directive.
Willy Tarreau80599772015-01-20 19:35:24 +010012983
David Carlier29b3ca32015-09-25 14:09:21 +010012984da-csv-conv(<prop>[,<prop>*])
David Carlier4542b102015-06-01 13:54:29 +020012985 Asks the DeviceAtlas converter to identify the User Agent string passed on
12986 input, and to emit a string made of the concatenation of the properties
12987 enumerated in argument, delimited by the separator defined by the global
12988 keyword "deviceatlas-property-separator", or by default the pipe character
David Carlier840b0242016-03-16 10:09:55 +000012989 ('|'). There's a limit of 12 different properties imposed by the haproxy
David Carlier4542b102015-06-01 13:54:29 +020012990 configuration language.
12991
12992 Example:
12993 frontend www
Cyril Bonté307ee1e2015-09-28 23:16:06 +020012994 bind *:8881
12995 default_backend servers
David Carlier840b0242016-03-16 10:09:55 +000012996 http-request set-header X-DeviceAtlas-Data %[req.fhdr(User-Agent),da-csv(primaryHardwareType,osName,osVersion,browserName,browserVersion,browserRenderingEngine)]
David Carlier4542b102015-06-01 13:54:29 +020012997
Thierry FOURNIER9687c772015-05-07 15:46:29 +020012998debug
12999 This converter is used as debug tool. It dumps on screen the content and the
13000 type of the input sample. The sample is returned as is on its output. This
13001 converter only exists when haproxy was built with debugging enabled.
13002
Willy Tarreau97707872015-01-27 15:12:13 +010013003div(<value>)
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +020013004 Divides the input value of type signed integer by <value>, and returns the
13005 result as an signed integer. If <value> is null, the largest unsigned
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +020013006 integer is returned (typically 2^63-1). <value> can be a numeric value or a
Daniel Schneller0b547052016-03-21 20:46:57 +010013007 variable name. The name of the variable starts with an indication about its
13008 scope. The scopes allowed are:
Christopher Fauletff2613e2016-11-09 11:36:17 +010013009 "proc" : the variable is shared with the whole process
Daniel Schneller0b547052016-03-21 20:46:57 +010013010 "sess" : the variable is shared with the whole session
13011 "txn" : the variable is shared with the transaction (request and response)
13012 "req" : the variable is shared only during request processing
13013 "res" : the variable is shared only during response processing
Davor Ocelice9ed2812017-12-25 17:49:28 +010013014 This prefix is followed by a name. The separator is a '.'. The name may only
Christopher Fauletb71557a2016-10-31 10:49:03 +010013015 contain characters 'a-z', 'A-Z', '0-9', '.' and '_'.
Willy Tarreau97707872015-01-27 15:12:13 +010013016
Willy Tarreau23ec4ca2014-07-15 20:15:37 +020013017djb2([<avalanche>])
13018 Hashes a binary input sample into an unsigned 32-bit quantity using the DJB2
13019 hash function. Optionally, it is possible to apply a full avalanche hash
13020 function to the output if the optional <avalanche> argument equals 1. This
13021 converter uses the same functions as used by the various hash-based load
13022 balancing algorithms, so it will provide exactly the same results. It is
13023 mostly intended for debugging, but can be used as a stick-table entry to
13024 collect rough statistics. It must not be used for security purposes as a
Emmanuel Hocdet50791a72018-03-21 11:19:01 +010013025 32-bit hash is trivial to break. See also "crc32", "sdbm", "wt6", "crc32c",
13026 and the "hash-type" directive.
Willy Tarreau23ec4ca2014-07-15 20:15:37 +020013027
Willy Tarreau97707872015-01-27 15:12:13 +010013028even
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +020013029 Returns a boolean TRUE if the input value of type signed integer is even
Willy Tarreau97707872015-01-27 15:12:13 +010013030 otherwise returns FALSE. It is functionally equivalent to "not,and(1),bool".
13031
Marcin Deranek9631a282018-04-16 14:30:46 +020013032field(<index>,<delimiters>[,<count>])
13033 Extracts the substring at the given index counting from the beginning
13034 (positive index) or from the end (negative index) considering given delimiters
13035 from an input string. Indexes start at 1 or -1 and delimiters are a string
13036 formatted list of chars. Optionally you can specify <count> of fields to
13037 extract (default: 1). Value of 0 indicates extraction of all remaining
13038 fields.
13039
13040 Example :
13041 str(f1_f2_f3__f5),field(5,_) # f5
13042 str(f1_f2_f3__f5),field(2,_,0) # f2_f3__f5
13043 str(f1_f2_f3__f5),field(2,_,2) # f2_f3
13044 str(f1_f2_f3__f5),field(-2,_,3) # f2_f3_
13045 str(f1_f2_f3__f5),field(-3,_,0) # f1_f2_f3
Emeric Brunf399b0d2014-11-03 17:07:03 +010013046
Thierry FOURNIER060762e2014-04-23 13:29:15 +020013047hex
Davor Ocelice9ed2812017-12-25 17:49:28 +010013048 Converts a binary input sample to a hex string containing two hex digits per
Thierry FOURNIER060762e2014-04-23 13:29:15 +020013049 input byte. It is used to log or transfer hex dumps of some binary input data
Davor Ocelice9ed2812017-12-25 17:49:28 +010013050 in a way that can be reliably transferred (e.g. an SSL ID can be copied in a
Thierry FOURNIER060762e2014-04-23 13:29:15 +020013051 header).
Thierry FOURNIER2f49d6d2014-03-12 15:01:52 +010013052
Dragan Dosen3f957b22017-10-24 09:27:34 +020013053hex2i
13054 Converts a hex string containing two hex digits per input byte to an
13055 integer. If the input value can not be converted, then zero is returned.
13056
Thierry FOURNIER060762e2014-04-23 13:29:15 +020013057http_date([<offset>])
13058 Converts an integer supposed to contain a date since epoch to a string
13059 representing this date in a format suitable for use in HTTP header fields. If
13060 an offset value is specified, then it is a number of seconds that is added to
13061 the date before the conversion is operated. This is particularly useful to
13062 emit Date header fields, Expires values in responses when combined with a
13063 positive offset, or Last-Modified values when the offset is negative.
Willy Tarreau74ca5042013-06-11 23:12:07 +020013064
Willy Tarreaud9f316a2014-07-10 14:03:38 +020013065in_table(<table>)
13066 Uses the string representation of the input sample to perform a look up in
13067 the specified table. If the key is not found in the table, a boolean false
13068 is returned. Otherwise a boolean true is returned. This can be used to verify
Davor Ocelice9ed2812017-12-25 17:49:28 +010013069 the presence of a certain key in a table tracking some elements (e.g. whether
Willy Tarreaud9f316a2014-07-10 14:03:38 +020013070 or not a source IP address or an Authorization header was already seen).
13071
Tim Duesterhus1478aa72018-01-25 16:24:51 +010013072ipmask(<mask4>, [<mask6>])
13073 Apply a mask to an IP address, and use the result for lookups and storage.
Willy Tarreauffcb2e42014-07-10 16:29:08 +020013074 This can be used to make all hosts within a certain mask to share the same
Tim Duesterhus1478aa72018-01-25 16:24:51 +010013075 table entries and as such use the same server. The mask4 can be passed in
13076 dotted form (e.g. 255.255.255.0) or in CIDR form (e.g. 24). The mask6 can
13077 be passed in quadruplet form (e.g. ffff:ffff::) or in CIDR form (e.g. 64).
13078 If no mask6 is given IPv6 addresses will fail to convert for backwards
13079 compatibility reasons.
Willy Tarreauffcb2e42014-07-10 16:29:08 +020013080
Thierry FOURNIER317e1c42014-08-12 10:20:47 +020013081json([<input-code>])
Davor Ocelice9ed2812017-12-25 17:49:28 +010013082 Escapes the input string and produces an ASCII output string ready to use as a
Thierry FOURNIER317e1c42014-08-12 10:20:47 +020013083 JSON string. The converter tries to decode the input string according to the
Herve COMMOWICK8dfe8632016-08-05 12:01:20 +020013084 <input-code> parameter. It can be "ascii", "utf8", "utf8s", "utf8p" or
Thierry FOURNIER317e1c42014-08-12 10:20:47 +020013085 "utf8ps". The "ascii" decoder never fails. The "utf8" decoder detects 3 types
13086 of errors:
13087 - bad UTF-8 sequence (lone continuation byte, bad number of continuation
13088 bytes, ...)
13089 - invalid range (the decoded value is within a UTF-8 prohibited range),
13090 - code overlong (the value is encoded with more bytes than necessary).
13091
13092 The UTF-8 JSON encoding can produce a "too long value" error when the UTF-8
13093 character is greater than 0xffff because the JSON string escape specification
13094 only authorizes 4 hex digits for the value encoding. The UTF-8 decoder exists
13095 in 4 variants designated by a combination of two suffix letters : "p" for
13096 "permissive" and "s" for "silently ignore". The behaviors of the decoders
13097 are :
Davor Ocelice9ed2812017-12-25 17:49:28 +010013098 - "ascii" : never fails;
13099 - "utf8" : fails on any detected errors;
13100 - "utf8s" : never fails, but removes characters corresponding to errors;
Thierry FOURNIER317e1c42014-08-12 10:20:47 +020013101 - "utf8p" : accepts and fixes the overlong errors, but fails on any other
Davor Ocelice9ed2812017-12-25 17:49:28 +010013102 error;
Thierry FOURNIER317e1c42014-08-12 10:20:47 +020013103 - "utf8ps" : never fails, accepts and fixes the overlong errors, but removes
13104 characters corresponding to the other errors.
13105
13106 This converter is particularly useful for building properly escaped JSON for
Davor Ocelice9ed2812017-12-25 17:49:28 +010013107 logging to servers which consume JSON-formatted traffic logs.
Thierry FOURNIER317e1c42014-08-12 10:20:47 +020013108
13109 Example:
Thierry FOURNIER317e1c42014-08-12 10:20:47 +020013110 capture request header Host len 15
Herve COMMOWICK8dfe8632016-08-05 12:01:20 +020013111 capture request header user-agent len 150
13112 log-format '{"ip":"%[src]","user-agent":"%[capture.req.hdr(1),json(utf8s)]"}'
Thierry FOURNIER317e1c42014-08-12 10:20:47 +020013113
13114 Input request from client 127.0.0.1:
13115 GET / HTTP/1.0
13116 User-Agent: Very "Ugly" UA 1/2
13117
13118 Output log:
13119 {"ip":"127.0.0.1","user-agent":"Very \"Ugly\" UA 1\/2"}
13120
Thierry FOURNIER060762e2014-04-23 13:29:15 +020013121language(<value>[,<default>])
13122 Returns the value with the highest q-factor from a list as extracted from the
13123 "accept-language" header using "req.fhdr". Values with no q-factor have a
13124 q-factor of 1. Values with a q-factor of 0 are dropped. Only values which
13125 belong to the list of semi-colon delimited <values> will be considered. The
13126 argument <value> syntax is "lang[;lang[;lang[;...]]]". If no value matches the
13127 given list and a default value is provided, it is returned. Note that language
13128 names may have a variant after a dash ('-'). If this variant is present in the
13129 list, it will be matched, but if it is not, only the base language is checked.
13130 The match is case-sensitive, and the output string is always one of those
Davor Ocelice9ed2812017-12-25 17:49:28 +010013131 provided in arguments. The ordering of arguments is meaningless, only the
Thierry FOURNIER060762e2014-04-23 13:29:15 +020013132 ordering of the values in the request counts, as the first value among
13133 multiple sharing the same q-factor is used.
Thierry FOURNIERad903512014-04-11 17:51:01 +020013134
Thierry FOURNIER060762e2014-04-23 13:29:15 +020013135 Example :
Thierry FOURNIERad903512014-04-11 17:51:01 +020013136
Thierry FOURNIER060762e2014-04-23 13:29:15 +020013137 # this configuration switches to the backend matching a
13138 # given language based on the request :
Thierry FOURNIERad903512014-04-11 17:51:01 +020013139
Thierry FOURNIER060762e2014-04-23 13:29:15 +020013140 acl es req.fhdr(accept-language),language(es;fr;en) -m str es
13141 acl fr req.fhdr(accept-language),language(es;fr;en) -m str fr
13142 acl en req.fhdr(accept-language),language(es;fr;en) -m str en
13143 use_backend spanish if es
13144 use_backend french if fr
13145 use_backend english if en
13146 default_backend choose_your_language
Thierry FOURNIERad903512014-04-11 17:51:01 +020013147
Willy Tarreau60a2ee72017-12-15 07:13:48 +010013148length
Etienne Carriereed0d24e2017-12-13 13:41:34 +010013149 Get the length of the string. This can only be placed after a string
13150 sample fetch function or after a transformation keyword returning a string
13151 type. The result is of type integer.
13152
Willy Tarreauffcb2e42014-07-10 16:29:08 +020013153lower
13154 Convert a string sample to lower case. This can only be placed after a string
13155 sample fetch function or after a transformation keyword returning a string
13156 type. The result is of type string.
13157
Willy Tarreau0dbfdba2014-07-10 16:37:47 +020013158ltime(<format>[,<offset>])
13159 Converts an integer supposed to contain a date since epoch to a string
13160 representing this date in local time using a format defined by the <format>
13161 string using strftime(3). The purpose is to allow any date format to be used
13162 in logs. An optional <offset> in seconds may be applied to the input date
13163 (positive or negative). See the strftime() man page for the format supported
13164 by your operating system. See also the utime converter.
13165
13166 Example :
13167
13168 # Emit two colons, one with the local time and another with ip:port
Davor Ocelice9ed2812017-12-25 17:49:28 +010013169 # e.g. 20140710162350 127.0.0.1:57325
Willy Tarreau0dbfdba2014-07-10 16:37:47 +020013170 log-format %[date,ltime(%Y%m%d%H%M%S)]\ %ci:%cp
13171
Thierry FOURNIER060762e2014-04-23 13:29:15 +020013172map(<map_file>[,<default_value>])
13173map_<match_type>(<map_file>[,<default_value>])
13174map_<match_type>_<output_type>(<map_file>[,<default_value>])
13175 Search the input value from <map_file> using the <match_type> matching method,
13176 and return the associated value converted to the type <output_type>. If the
13177 input value cannot be found in the <map_file>, the converter returns the
13178 <default_value>. If the <default_value> is not set, the converter fails and
13179 acts as if no input value could be fetched. If the <match_type> is not set, it
13180 defaults to "str". Likewise, if the <output_type> is not set, it defaults to
13181 "str". For convenience, the "map" keyword is an alias for "map_str" and maps a
13182 string to another string.
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010013183
Thierry FOURNIER060762e2014-04-23 13:29:15 +020013184 It is important to avoid overlapping between the keys : IP addresses and
13185 strings are stored in trees, so the first of the finest match will be used.
13186 Other keys are stored in lists, so the first matching occurrence will be used.
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010013187
Tim Düsterhus4896c442016-11-29 02:15:19 +010013188 The following array contains the list of all map functions available sorted by
Thierry FOURNIER060762e2014-04-23 13:29:15 +020013189 input type, match type and output type.
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010013190
Thierry FOURNIER060762e2014-04-23 13:29:15 +020013191 input type | match method | output type str | output type int | output type ip
13192 -----------+--------------+-----------------+-----------------+---------------
13193 str | str | map_str | map_str_int | map_str_ip
13194 -----------+--------------+-----------------+-----------------+---------------
Willy Tarreau787a4c02014-05-10 07:55:30 +020013195 str | beg | map_beg | map_beg_int | map_end_ip
13196 -----------+--------------+-----------------+-----------------+---------------
Thierry FOURNIER060762e2014-04-23 13:29:15 +020013197 str | sub | map_sub | map_sub_int | map_sub_ip
13198 -----------+--------------+-----------------+-----------------+---------------
13199 str | dir | map_dir | map_dir_int | map_dir_ip
13200 -----------+--------------+-----------------+-----------------+---------------
13201 str | dom | map_dom | map_dom_int | map_dom_ip
13202 -----------+--------------+-----------------+-----------------+---------------
13203 str | end | map_end | map_end_int | map_end_ip
13204 -----------+--------------+-----------------+-----------------+---------------
Ruoshan Huang3c5e3742016-12-02 16:25:31 +080013205 str | reg | map_reg | map_reg_int | map_reg_ip
13206 -----------+--------------+-----------------+-----------------+---------------
13207 str | reg | map_regm | map_reg_int | map_reg_ip
Thierry FOURNIER060762e2014-04-23 13:29:15 +020013208 -----------+--------------+-----------------+-----------------+---------------
13209 int | int | map_int | map_int_int | map_int_ip
13210 -----------+--------------+-----------------+-----------------+---------------
13211 ip | ip | map_ip | map_ip_int | map_ip_ip
13212 -----------+--------------+-----------------+-----------------+---------------
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010013213
Thierry Fournier8feaa662016-02-10 22:55:20 +010013214 The special map called "map_regm" expect matching zone in the regular
13215 expression and modify the output replacing back reference (like "\1") by
13216 the corresponding match text.
13217
Thierry FOURNIER060762e2014-04-23 13:29:15 +020013218 The file contains one key + value per line. Lines which start with '#' are
13219 ignored, just like empty lines. Leading tabs and spaces are stripped. The key
13220 is then the first "word" (series of non-space/tabs characters), and the value
13221 is what follows this series of space/tab till the end of the line excluding
13222 trailing spaces/tabs.
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010013223
Thierry FOURNIER060762e2014-04-23 13:29:15 +020013224 Example :
13225
13226 # this is a comment and is ignored
13227 2.22.246.0/23 United Kingdom \n
13228 <-><-----------><--><------------><---->
13229 | | | | `- trailing spaces ignored
13230 | | | `---------- value
13231 | | `-------------------- middle spaces ignored
13232 | `---------------------------- key
13233 `------------------------------------ leading spaces ignored
13234
Willy Tarreau97707872015-01-27 15:12:13 +010013235mod(<value>)
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +020013236 Divides the input value of type signed integer by <value>, and returns the
13237 remainder as an signed integer. If <value> is null, then zero is returned.
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +020013238 <value> can be a numeric value or a variable name. The name of the variable
Daniel Schneller0b547052016-03-21 20:46:57 +010013239 starts with an indication about its scope. The scopes allowed are:
Christopher Fauletff2613e2016-11-09 11:36:17 +010013240 "proc" : the variable is shared with the whole process
Daniel Schneller0b547052016-03-21 20:46:57 +010013241 "sess" : the variable is shared with the whole session
13242 "txn" : the variable is shared with the transaction (request and response)
13243 "req" : the variable is shared only during request processing
13244 "res" : the variable is shared only during response processing
Davor Ocelice9ed2812017-12-25 17:49:28 +010013245 This prefix is followed by a name. The separator is a '.'. The name may only
Christopher Fauletb71557a2016-10-31 10:49:03 +010013246 contain characters 'a-z', 'A-Z', '0-9', '.' and '_'.
Willy Tarreau97707872015-01-27 15:12:13 +010013247
13248mul(<value>)
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +020013249 Multiplies the input value of type signed integer by <value>, and returns
Thierry FOURNIER00c005c2015-07-08 01:10:21 +020013250 the product as an signed integer. In case of overflow, the largest possible
13251 value for the sign is returned so that the operation doesn't wrap around.
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +020013252 <value> can be a numeric value or a variable name. The name of the variable
Daniel Schneller0b547052016-03-21 20:46:57 +010013253 starts with an indication about its scope. The scopes allowed are:
Christopher Fauletff2613e2016-11-09 11:36:17 +010013254 "proc" : the variable is shared with the whole process
Daniel Schneller0b547052016-03-21 20:46:57 +010013255 "sess" : the variable is shared with the whole session
13256 "txn" : the variable is shared with the transaction (request and response)
13257 "req" : the variable is shared only during request processing
13258 "res" : the variable is shared only during response processing
Davor Ocelice9ed2812017-12-25 17:49:28 +010013259 This prefix is followed by a name. The separator is a '.'. The name may only
Christopher Fauletb71557a2016-10-31 10:49:03 +010013260 contain characters 'a-z', 'A-Z', '0-9', '.' and '_'.
Willy Tarreau97707872015-01-27 15:12:13 +010013261
Nenad Merdanovicb7e7c472017-03-12 21:56:55 +010013262nbsrv
13263 Takes an input value of type string, interprets it as a backend name and
13264 returns the number of usable servers in that backend. Can be used in places
13265 where we want to look up a backend from a dynamic name, like a result of a
13266 map lookup.
13267
Willy Tarreau97707872015-01-27 15:12:13 +010013268neg
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +020013269 Takes the input value of type signed integer, computes the opposite value,
13270 and returns the remainder as an signed integer. 0 is identity. This operator
13271 is provided for reversed subtracts : in order to subtract the input from a
13272 constant, simply perform a "neg,add(value)".
Willy Tarreau97707872015-01-27 15:12:13 +010013273
13274not
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +020013275 Returns a boolean FALSE if the input value of type signed integer is
Willy Tarreau97707872015-01-27 15:12:13 +010013276 non-null, otherwise returns TRUE. Used in conjunction with and(), it can be
Davor Ocelice9ed2812017-12-25 17:49:28 +010013277 used to report true/false for bit testing on input values (e.g. verify the
Willy Tarreau97707872015-01-27 15:12:13 +010013278 absence of a flag).
13279
13280odd
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +020013281 Returns a boolean TRUE if the input value of type signed integer is odd
Willy Tarreau97707872015-01-27 15:12:13 +010013282 otherwise returns FALSE. It is functionally equivalent to "and(1),bool".
13283
13284or(<value>)
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +020013285 Performs a bitwise "OR" between <value> and the input value of type signed
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +020013286 integer, and returns the result as an signed integer. <value> can be a
Daniel Schneller0b547052016-03-21 20:46:57 +010013287 numeric value or a variable name. The name of the variable starts with an
13288 indication about its scope. The scopes allowed are:
Christopher Fauletff2613e2016-11-09 11:36:17 +010013289 "proc" : the variable is shared with the whole process
Daniel Schneller0b547052016-03-21 20:46:57 +010013290 "sess" : the variable is shared with the whole session
13291 "txn" : the variable is shared with the transaction (request and response)
13292 "req" : the variable is shared only during request processing
13293 "res" : the variable is shared only during response processing
Davor Ocelice9ed2812017-12-25 17:49:28 +010013294 This prefix is followed by a name. The separator is a '.'. The name may only
Christopher Fauletb71557a2016-10-31 10:49:03 +010013295 contain characters 'a-z', 'A-Z', '0-9', '.' and '_'.
Willy Tarreau97707872015-01-27 15:12:13 +010013296
Willy Tarreauc4dc3502015-01-23 20:39:28 +010013297regsub(<regex>,<subst>[,<flags>])
Willy Tarreau7eda8492015-01-20 19:47:06 +010013298 Applies a regex-based substitution to the input string. It does the same
13299 operation as the well-known "sed" utility with "s/<regex>/<subst>/". By
13300 default it will replace in the input string the first occurrence of the
13301 largest part matching the regular expression <regex> with the substitution
13302 string <subst>. It is possible to replace all occurrences instead by adding
13303 the flag "g" in the third argument <flags>. It is also possible to make the
13304 regex case insensitive by adding the flag "i" in <flags>. Since <flags> is a
13305 string, it is made up from the concatenation of all desired flags. Thus if
13306 both "i" and "g" are desired, using "gi" or "ig" will have the same effect.
13307 It is important to note that due to the current limitations of the
Baptiste Assmann66025d82016-03-06 23:36:48 +010013308 configuration parser, some characters such as closing parenthesis, closing
13309 square brackets or comma are not possible to use in the arguments. The first
13310 use of this converter is to replace certain characters or sequence of
13311 characters with other ones.
Willy Tarreau7eda8492015-01-20 19:47:06 +010013312
13313 Example :
13314
13315 # de-duplicate "/" in header "x-path".
13316 # input: x-path: /////a///b/c/xzxyz/
13317 # output: x-path: /a/b/c/xzxyz/
13318 http-request set-header x-path %[hdr(x-path),regsub(/+,/,g)]
13319
Thierry FOURNIER35ab2752015-05-28 13:22:03 +020013320capture-req(<id>)
13321 Capture the string entry in the request slot <id> and returns the entry as
13322 is. If the slot doesn't exist, the capture fails silently.
13323
13324 See also: "declare capture", "http-request capture",
Baptiste Assmann5ac425c2015-10-21 23:13:46 +020013325 "http-response capture", "capture.req.hdr" and
13326 "capture.res.hdr" (sample fetches).
Thierry FOURNIER35ab2752015-05-28 13:22:03 +020013327
13328capture-res(<id>)
13329 Capture the string entry in the response slot <id> and returns the entry as
13330 is. If the slot doesn't exist, the capture fails silently.
13331
13332 See also: "declare capture", "http-request capture",
Baptiste Assmann5ac425c2015-10-21 23:13:46 +020013333 "http-response capture", "capture.req.hdr" and
13334 "capture.res.hdr" (sample fetches).
Thierry FOURNIER35ab2752015-05-28 13:22:03 +020013335
Willy Tarreau23ec4ca2014-07-15 20:15:37 +020013336sdbm([<avalanche>])
13337 Hashes a binary input sample into an unsigned 32-bit quantity using the SDBM
13338 hash function. Optionally, it is possible to apply a full avalanche hash
13339 function to the output if the optional <avalanche> argument equals 1. This
13340 converter uses the same functions as used by the various hash-based load
13341 balancing algorithms, so it will provide exactly the same results. It is
13342 mostly intended for debugging, but can be used as a stick-table entry to
13343 collect rough statistics. It must not be used for security purposes as a
Emmanuel Hocdet50791a72018-03-21 11:19:01 +010013344 32-bit hash is trivial to break. See also "crc32", "djb2", "wt6", "crc32c",
13345 and the "hash-type" directive.
Willy Tarreau23ec4ca2014-07-15 20:15:37 +020013346
Thierry FOURNIER4834bc72015-06-06 19:29:07 +020013347set-var(<var name>)
Davor Ocelice9ed2812017-12-25 17:49:28 +010013348 Sets a variable with the input content and returns the content on the output
13349 as-is. The variable keeps the value and the associated input type. The name of
13350 the variable starts with an indication about its scope. The scopes allowed are:
Christopher Fauletff2613e2016-11-09 11:36:17 +010013351 "proc" : the variable is shared with the whole process
Daniel Schneller0b547052016-03-21 20:46:57 +010013352 "sess" : the variable is shared with the whole session
13353 "txn" : the variable is shared with the transaction (request and
Thierry FOURNIER4834bc72015-06-06 19:29:07 +020013354 response),
Daniel Schneller0b547052016-03-21 20:46:57 +010013355 "req" : the variable is shared only during request processing,
13356 "res" : the variable is shared only during response processing.
Thierry FOURNIER4834bc72015-06-06 19:29:07 +020013357 This prefix is followed by a name. The separator is a '.'. The name may only
Christopher Fauletb71557a2016-10-31 10:49:03 +010013358 contain characters 'a-z', 'A-Z', '0-9', '.' and '_'.
Thierry FOURNIER4834bc72015-06-06 19:29:07 +020013359
Dragan Dosen6e5a9ca2017-10-24 09:18:23 +020013360sha1
13361 Converts a binary input sample to a SHA1 digest. The result is a binary
13362 sample with length of 20 bytes.
13363
Tim Duesterhusca097c12018-04-27 21:18:45 +020013364strcmp(<var>)
13365 Compares the contents of <var> with the input value of type string. Returns
13366 the result as a signed integer compatible with strcmp(3): 0 if both strings
13367 are identical. A value less than 0 if the left string is lexicographically
13368 smaller than the right string or if the left string is shorter. A value greater
13369 than 0 otherwise (right string greater than left string or the right string is
13370 shorter).
13371
13372 Example :
13373
13374 http-request set-var(txn.host) hdr(host)
13375 # Check whether the client is attempting domain fronting.
13376 acl ssl_sni_http_host_match ssl_fc_sni,strcmp(txn.host) eq 0
13377
13378
Willy Tarreau97707872015-01-27 15:12:13 +010013379sub(<value>)
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +020013380 Subtracts <value> from the input value of type signed integer, and returns
13381 the result as an signed integer. Note: in order to subtract the input from
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +020013382 a constant, simply perform a "neg,add(value)". <value> can be a numeric value
Daniel Schneller0b547052016-03-21 20:46:57 +010013383 or a variable name. The name of the variable starts with an indication about
13384 its scope. The scopes allowed are:
Christopher Fauletff2613e2016-11-09 11:36:17 +010013385 "proc" : the variable is shared with the whole process
Daniel Schneller0b547052016-03-21 20:46:57 +010013386 "sess" : the variable is shared with the whole session
13387 "txn" : the variable is shared with the transaction (request and
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +020013388 response),
Daniel Schneller0b547052016-03-21 20:46:57 +010013389 "req" : the variable is shared only during request processing,
13390 "res" : the variable is shared only during response processing.
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +020013391 This prefix is followed by a name. The separator is a '.'. The name may only
Christopher Fauletb71557a2016-10-31 10:49:03 +010013392 contain characters 'a-z', 'A-Z', '0-9', '.' and '_'.
Willy Tarreau97707872015-01-27 15:12:13 +010013393
Willy Tarreaud9f316a2014-07-10 14:03:38 +020013394table_bytes_in_rate(<table>)
13395 Uses the string representation of the input sample to perform a look up in
13396 the specified table. If the key is not found in the table, integer value zero
13397 is returned. Otherwise the converter returns the average client-to-server
13398 bytes rate associated with the input sample in the designated table, measured
13399 in amount of bytes over the period configured in the table. See also the
13400 sc_bytes_in_rate sample fetch keyword.
13401
13402
13403table_bytes_out_rate(<table>)
13404 Uses the string representation of the input sample to perform a look up in
13405 the specified table. If the key is not found in the table, integer value zero
13406 is returned. Otherwise the converter returns the average server-to-client
13407 bytes rate associated with the input sample in the designated table, measured
13408 in amount of bytes over the period configured in the table. See also the
13409 sc_bytes_out_rate sample fetch keyword.
13410
13411table_conn_cnt(<table>)
13412 Uses the string representation of the input sample to perform a look up in
13413 the specified table. If the key is not found in the table, integer value zero
Davor Ocelice9ed2812017-12-25 17:49:28 +010013414 is returned. Otherwise the converter returns the cumulative number of incoming
Willy Tarreaud9f316a2014-07-10 14:03:38 +020013415 connections associated with the input sample in the designated table. See
13416 also the sc_conn_cnt sample fetch keyword.
13417
13418table_conn_cur(<table>)
13419 Uses the string representation of the input sample to perform a look up in
13420 the specified table. If the key is not found in the table, integer value zero
13421 is returned. Otherwise the converter returns the current amount of concurrent
13422 tracked connections associated with the input sample in the designated table.
13423 See also the sc_conn_cur sample fetch keyword.
13424
13425table_conn_rate(<table>)
13426 Uses the string representation of the input sample to perform a look up in
13427 the specified table. If the key is not found in the table, integer value zero
13428 is returned. Otherwise the converter returns the average incoming connection
13429 rate associated with the input sample in the designated table. See also the
13430 sc_conn_rate sample fetch keyword.
13431
Thierry FOURNIER236657b2015-08-19 08:25:14 +020013432table_gpt0(<table>)
13433 Uses the string representation of the input sample to perform a look up in
13434 the specified table. If the key is not found in the table, boolean value zero
13435 is returned. Otherwise the converter returns the current value of the first
13436 general purpose tag associated with the input sample in the designated table.
13437 See also the sc_get_gpt0 sample fetch keyword.
13438
Willy Tarreaud9f316a2014-07-10 14:03:38 +020013439table_gpc0(<table>)
13440 Uses the string representation of the input sample to perform a look up in
13441 the specified table. If the key is not found in the table, integer value zero
13442 is returned. Otherwise the converter returns the current value of the first
13443 general purpose counter associated with the input sample in the designated
13444 table. See also the sc_get_gpc0 sample fetch keyword.
13445
13446table_gpc0_rate(<table>)
13447 Uses the string representation of the input sample to perform a look up in
13448 the specified table. If the key is not found in the table, integer value zero
13449 is returned. Otherwise the converter returns the frequency which the gpc0
13450 counter was incremented over the configured period in the table, associated
13451 with the input sample in the designated table. See also the sc_get_gpc0_rate
13452 sample fetch keyword.
13453
Frédéric Lécaille6778b272018-01-29 15:22:53 +010013454table_gpc1(<table>)
13455 Uses the string representation of the input sample to perform a look up in
13456 the specified table. If the key is not found in the table, integer value zero
13457 is returned. Otherwise the converter returns the current value of the second
13458 general purpose counter associated with the input sample in the designated
13459 table. See also the sc_get_gpc1 sample fetch keyword.
13460
13461table_gpc1_rate(<table>)
13462 Uses the string representation of the input sample to perform a look up in
13463 the specified table. If the key is not found in the table, integer value zero
13464 is returned. Otherwise the converter returns the frequency which the gpc1
13465 counter was incremented over the configured period in the table, associated
13466 with the input sample in the designated table. See also the sc_get_gpc1_rate
13467 sample fetch keyword.
13468
Willy Tarreaud9f316a2014-07-10 14:03:38 +020013469table_http_err_cnt(<table>)
13470 Uses the string representation of the input sample to perform a look up in
13471 the specified table. If the key is not found in the table, integer value zero
Davor Ocelice9ed2812017-12-25 17:49:28 +010013472 is returned. Otherwise the converter returns the cumulative number of HTTP
Willy Tarreaud9f316a2014-07-10 14:03:38 +020013473 errors associated with the input sample in the designated table. See also the
13474 sc_http_err_cnt sample fetch keyword.
13475
13476table_http_err_rate(<table>)
13477 Uses the string representation of the input sample to perform a look up in
13478 the specified table. If the key is not found in the table, integer value zero
13479 is returned. Otherwise the average rate of HTTP errors associated with the
13480 input sample in the designated table, measured in amount of errors over the
13481 period configured in the table. See also the sc_http_err_rate sample fetch
13482 keyword.
13483
13484table_http_req_cnt(<table>)
13485 Uses the string representation of the input sample to perform a look up in
13486 the specified table. If the key is not found in the table, integer value zero
Davor Ocelice9ed2812017-12-25 17:49:28 +010013487 is returned. Otherwise the converter returns the cumulative number of HTTP
Willy Tarreaud9f316a2014-07-10 14:03:38 +020013488 requests associated with the input sample in the designated table. See also
13489 the sc_http_req_cnt sample fetch keyword.
13490
13491table_http_req_rate(<table>)
13492 Uses the string representation of the input sample to perform a look up in
13493 the specified table. If the key is not found in the table, integer value zero
13494 is returned. Otherwise the average rate of HTTP requests associated with the
13495 input sample in the designated table, measured in amount of requests over the
13496 period configured in the table. See also the sc_http_req_rate sample fetch
13497 keyword.
13498
13499table_kbytes_in(<table>)
13500 Uses the string representation of the input sample to perform a look up in
13501 the specified table. If the key is not found in the table, integer value zero
Davor Ocelice9ed2812017-12-25 17:49:28 +010013502 is returned. Otherwise the converter returns the cumulative number of client-
Willy Tarreaud9f316a2014-07-10 14:03:38 +020013503 to-server data associated with the input sample in the designated table,
13504 measured in kilobytes. The test is currently performed on 32-bit integers,
13505 which limits values to 4 terabytes. See also the sc_kbytes_in sample fetch
13506 keyword.
13507
13508table_kbytes_out(<table>)
13509 Uses the string representation of the input sample to perform a look up in
13510 the specified table. If the key is not found in the table, integer value zero
Davor Ocelice9ed2812017-12-25 17:49:28 +010013511 is returned. Otherwise the converter returns the cumulative number of server-
Willy Tarreaud9f316a2014-07-10 14:03:38 +020013512 to-client data associated with the input sample in the designated table,
13513 measured in kilobytes. The test is currently performed on 32-bit integers,
13514 which limits values to 4 terabytes. See also the sc_kbytes_out sample fetch
13515 keyword.
13516
13517table_server_id(<table>)
13518 Uses the string representation of the input sample to perform a look up in
13519 the specified table. If the key is not found in the table, integer value zero
13520 is returned. Otherwise the converter returns the server ID associated with
13521 the input sample in the designated table. A server ID is associated to a
13522 sample by a "stick" rule when a connection to a server succeeds. A server ID
13523 zero means that no server is associated with this key.
13524
13525table_sess_cnt(<table>)
13526 Uses the string representation of the input sample to perform a look up in
13527 the specified table. If the key is not found in the table, integer value zero
Davor Ocelice9ed2812017-12-25 17:49:28 +010013528 is returned. Otherwise the converter returns the cumulative number of incoming
Willy Tarreaud9f316a2014-07-10 14:03:38 +020013529 sessions associated with the input sample in the designated table. Note that
13530 a session here refers to an incoming connection being accepted by the
13531 "tcp-request connection" rulesets. See also the sc_sess_cnt sample fetch
13532 keyword.
13533
13534table_sess_rate(<table>)
13535 Uses the string representation of the input sample to perform a look up in
13536 the specified table. If the key is not found in the table, integer value zero
13537 is returned. Otherwise the converter returns the average incoming session
13538 rate associated with the input sample in the designated table. Note that a
13539 session here refers to an incoming connection being accepted by the
13540 "tcp-request connection" rulesets. See also the sc_sess_rate sample fetch
13541 keyword.
13542
13543table_trackers(<table>)
13544 Uses the string representation of the input sample to perform a look up in
13545 the specified table. If the key is not found in the table, integer value zero
13546 is returned. Otherwise the converter returns the current amount of concurrent
13547 connections tracking the same key as the input sample in the designated
13548 table. It differs from table_conn_cur in that it does not rely on any stored
13549 information but on the table's reference count (the "use" value which is
13550 returned by "show table" on the CLI). This may sometimes be more suited for
13551 layer7 tracking. It can be used to tell a server how many concurrent
13552 connections there are from a given address for example. See also the
13553 sc_trackers sample fetch keyword.
13554
Willy Tarreauffcb2e42014-07-10 16:29:08 +020013555upper
13556 Convert a string sample to upper case. This can only be placed after a string
13557 sample fetch function or after a transformation keyword returning a string
13558 type. The result is of type string.
13559
Thierry FOURNIER82ff3c92015-05-07 15:46:20 +020013560url_dec
13561 Takes an url-encoded string provided as input and returns the decoded
13562 version as output. The input and the output are of type string.
13563
Christopher Faulet85d79c92016-11-09 16:54:56 +010013564unset-var(<var name>)
13565 Unsets a variable if the input content is defined. The name of the variable
13566 starts with an indication about its scope. The scopes allowed are:
13567 "proc" : the variable is shared with the whole process
13568 "sess" : the variable is shared with the whole session
13569 "txn" : the variable is shared with the transaction (request and
13570 response),
13571 "req" : the variable is shared only during request processing,
13572 "res" : the variable is shared only during response processing.
13573 This prefix is followed by a name. The separator is a '.'. The name may only
13574 contain characters 'a-z', 'A-Z', '0-9', '.' and '_'.
13575
Willy Tarreau0dbfdba2014-07-10 16:37:47 +020013576utime(<format>[,<offset>])
13577 Converts an integer supposed to contain a date since epoch to a string
13578 representing this date in UTC time using a format defined by the <format>
13579 string using strftime(3). The purpose is to allow any date format to be used
13580 in logs. An optional <offset> in seconds may be applied to the input date
13581 (positive or negative). See the strftime() man page for the format supported
13582 by your operating system. See also the ltime converter.
13583
13584 Example :
13585
13586 # Emit two colons, one with the UTC time and another with ip:port
Davor Ocelice9ed2812017-12-25 17:49:28 +010013587 # e.g. 20140710162350 127.0.0.1:57325
Willy Tarreau0dbfdba2014-07-10 16:37:47 +020013588 log-format %[date,utime(%Y%m%d%H%M%S)]\ %ci:%cp
13589
Marcin Deranek9631a282018-04-16 14:30:46 +020013590word(<index>,<delimiters>[,<count>])
13591 Extracts the nth word counting from the beginning (positive index) or from
13592 the end (negative index) considering given delimiters from an input string.
13593 Indexes start at 1 or -1 and delimiters are a string formatted list of chars.
13594 Optionally you can specify <count> of words to extract (default: 1).
13595 Value of 0 indicates extraction of all remaining words.
13596
13597 Example :
13598 str(f1_f2_f3__f5),word(4,_) # f5
13599 str(f1_f2_f3__f5),word(2,_,0) # f2_f3__f5
13600 str(f1_f2_f3__f5),word(3,_,2) # f3__f5
13601 str(f1_f2_f3__f5),word(-2,_,3) # f1_f2_f3
13602 str(f1_f2_f3__f5),word(-3,_,0) # f1_f2
Emeric Brunc9a0f6d2014-11-25 14:09:01 +010013603
Willy Tarreau23ec4ca2014-07-15 20:15:37 +020013604wt6([<avalanche>])
13605 Hashes a binary input sample into an unsigned 32-bit quantity using the WT6
13606 hash function. Optionally, it is possible to apply a full avalanche hash
13607 function to the output if the optional <avalanche> argument equals 1. This
13608 converter uses the same functions as used by the various hash-based load
13609 balancing algorithms, so it will provide exactly the same results. It is
13610 mostly intended for debugging, but can be used as a stick-table entry to
13611 collect rough statistics. It must not be used for security purposes as a
Emmanuel Hocdet50791a72018-03-21 11:19:01 +010013612 32-bit hash is trivial to break. See also "crc32", "djb2", "sdbm", "crc32c",
13613 and the "hash-type" directive.
Willy Tarreau23ec4ca2014-07-15 20:15:37 +020013614
Willy Tarreau97707872015-01-27 15:12:13 +010013615xor(<value>)
13616 Performs a bitwise "XOR" (exclusive OR) between <value> and the input value
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +020013617 of type signed integer, and returns the result as an signed integer.
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +020013618 <value> can be a numeric value or a variable name. The name of the variable
Daniel Schneller0b547052016-03-21 20:46:57 +010013619 starts with an indication about its scope. The scopes allowed are:
Christopher Fauletff2613e2016-11-09 11:36:17 +010013620 "proc" : the variable is shared with the whole process
Daniel Schneller0b547052016-03-21 20:46:57 +010013621 "sess" : the variable is shared with the whole session
13622 "txn" : the variable is shared with the transaction (request and
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +020013623 response),
Daniel Schneller0b547052016-03-21 20:46:57 +010013624 "req" : the variable is shared only during request processing,
13625 "res" : the variable is shared only during response processing.
Thierry FOURNIER5d86fae2015-07-07 21:10:16 +020013626 This prefix is followed by a name. The separator is a '.'. The name may only
Christopher Fauletb71557a2016-10-31 10:49:03 +010013627 contain characters 'a-z', 'A-Z', '0-9', '.' and '_'.
Willy Tarreau97707872015-01-27 15:12:13 +010013628
Thierry FOURNIER01e09742016-12-26 11:46:11 +010013629xxh32([<seed>])
13630 Hashes a binary input sample into an unsigned 32-bit quantity using the 32-bit
13631 variant of the XXHash hash function. This hash supports a seed which defaults
13632 to zero but a different value maybe passed as the <seed> argument. This hash
13633 is known to be very good and very fast so it can be used to hash URLs and/or
13634 URL parameters for use as stick-table keys to collect statistics with a low
13635 collision rate, though care must be taken as the algorithm is not considered
13636 as cryptographically secure.
13637
13638xxh64([<seed>])
13639 Hashes a binary input sample into a signed 64-bit quantity using the 64-bit
13640 variant of the XXHash hash function. This hash supports a seed which defaults
13641 to zero but a different value maybe passed as the <seed> argument. This hash
13642 is known to be very good and very fast so it can be used to hash URLs and/or
13643 URL parameters for use as stick-table keys to collect statistics with a low
13644 collision rate, though care must be taken as the algorithm is not considered
13645 as cryptographically secure.
13646
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010013647
Thierry FOURNIER060762e2014-04-23 13:29:15 +0200136487.3.2. Fetching samples from internal states
Willy Tarreau74ca5042013-06-11 23:12:07 +020013649--------------------------------------------
13650
13651A first set of sample fetch methods applies to internal information which does
13652not even relate to any client information. These ones are sometimes used with
13653"monitor-fail" directives to report an internal status to external watchers.
13654The sample fetch methods described in this section are usable anywhere.
13655
13656always_false : boolean
13657 Always returns the boolean "false" value. It may be used with ACLs as a
13658 temporary replacement for another one when adjusting configurations.
13659
13660always_true : boolean
13661 Always returns the boolean "true" value. It may be used with ACLs as a
13662 temporary replacement for another one when adjusting configurations.
13663
13664avg_queue([<backend>]) : integer
Willy Tarreaud63335a2010-02-26 12:56:52 +010013665 Returns the total number of queued connections of the designated backend
Willy Tarreau74ca5042013-06-11 23:12:07 +020013666 divided by the number of active servers. The current backend is used if no
13667 backend is specified. This is very similar to "queue" except that the size of
13668 the farm is considered, in order to give a more accurate measurement of the
13669 time it may take for a new connection to be processed. The main usage is with
13670 ACL to return a sorry page to new users when it becomes certain they will get
13671 a degraded service, or to pass to the backend servers in a header so that
13672 they decide to work in degraded mode or to disable some functions to speed up
13673 the processing a bit. Note that in the event there would not be any active
13674 server anymore, twice the number of queued connections would be considered as
13675 the measured value. This is a fair estimate, as we expect one server to get
13676 back soon anyway, but we still prefer to send new traffic to another backend
13677 if in better shape. See also the "queue", "be_conn", and "be_sess_rate"
13678 sample fetches.
Krzysztof Piotr Oledzki346f76d2010-01-12 21:59:30 +010013679
Willy Tarreau74ca5042013-06-11 23:12:07 +020013680be_conn([<backend>]) : integer
Willy Tarreaua36af912009-10-10 12:02:45 +020013681 Applies to the number of currently established connections on the backend,
13682 possibly including the connection being evaluated. If no backend name is
13683 specified, the current one is used. But it is also possible to check another
13684 backend. It can be used to use a specific farm when the nominal one is full.
Patrick Hemmer4cdf3ab2018-06-14 17:10:27 -040013685 See also the "fe_conn", "queue", "be_conn_free", and "be_sess_rate" criteria.
13686
13687be_conn_free([<backend>]) : integer
13688 Returns an integer value corresponding to the number of available connections
13689 across available servers in the backend. Queue slots are not included. Backup
13690 servers are also not included, unless all other servers are down. If no
13691 backend name is specified, the current one is used. But it is also possible
13692 to check another backend. It can be used to use a specific farm when the
Patrick Hemmer155e93e2018-06-14 18:01:35 -040013693 nominal one is full. See also the "be_conn", "connslots", and "srv_conn_free"
13694 criteria.
Patrick Hemmer4cdf3ab2018-06-14 17:10:27 -040013695
13696 OTHER CAVEATS AND NOTES: if any of the server maxconn, or maxqueue is 0
13697 (meaning unlimited), then this fetch clearly does not make sense, in which
13698 case the value returned will be -1.
Willy Tarreau6a06a402007-07-15 20:15:28 +020013699
Willy Tarreau74ca5042013-06-11 23:12:07 +020013700be_sess_rate([<backend>]) : integer
13701 Returns an integer value corresponding to the sessions creation rate on the
13702 backend, in number of new sessions per second. This is used with ACLs to
13703 switch to an alternate backend when an expensive or fragile one reaches too
Davor Ocelice9ed2812017-12-25 17:49:28 +010013704 high a session rate, or to limit abuse of service (e.g. prevent sucking of an
Willy Tarreau74ca5042013-06-11 23:12:07 +020013705 online dictionary). It can also be useful to add this element to logs using a
13706 log-format directive.
Willy Tarreaud63335a2010-02-26 12:56:52 +010013707
13708 Example :
13709 # Redirect to an error page if the dictionary is requested too often
13710 backend dynamic
13711 mode http
13712 acl being_scanned be_sess_rate gt 100
13713 redirect location /denied.html if being_scanned
Willy Tarreau0ba27502007-12-24 16:55:16 +010013714
Davor Ocelice9ed2812017-12-25 17:49:28 +010013715bin(<hex>) : bin
Thierry FOURNIERcc103292015-06-06 19:30:17 +020013716 Returns a binary chain. The input is the hexadecimal representation
13717 of the string.
13718
13719bool(<bool>) : bool
13720 Returns a boolean value. <bool> can be 'true', 'false', '1' or '0'.
13721 'false' and '0' are the same. 'true' and '1' are the same.
13722
Willy Tarreau74ca5042013-06-11 23:12:07 +020013723connslots([<backend>]) : integer
13724 Returns an integer value corresponding to the number of connection slots
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030013725 still available in the backend, by totaling the maximum amount of
Willy Tarreau74ca5042013-06-11 23:12:07 +020013726 connections on all servers and the maximum queue size. This is probably only
13727 used with ACLs.
Tait Clarridge7896d522012-12-05 21:39:31 -050013728
Jeffrey 'jf' Lim5051d7b2008-09-04 01:03:03 +080013729 The basic idea here is to be able to measure the number of connection "slots"
Willy Tarreau55165fe2009-05-10 12:02:55 +020013730 still available (connection + queue), so that anything beyond that (intended
Jeffrey 'jf' Lim5051d7b2008-09-04 01:03:03 +080013731 usage; see "use_backend" keyword) can be redirected to a different backend.
13732
Willy Tarreau55165fe2009-05-10 12:02:55 +020013733 'connslots' = number of available server connection slots, + number of
13734 available server queue slots.
Jeffrey 'jf' Lim5051d7b2008-09-04 01:03:03 +080013735
Willy Tarreaua36af912009-10-10 12:02:45 +020013736 Note that while "fe_conn" may be used, "connslots" comes in especially
Willy Tarreau55165fe2009-05-10 12:02:55 +020013737 useful when you have a case of traffic going to one single ip, splitting into
Willy Tarreau74ca5042013-06-11 23:12:07 +020013738 multiple backends (perhaps using ACLs to do name-based load balancing) and
Willy Tarreau55165fe2009-05-10 12:02:55 +020013739 you want to be able to differentiate between different backends, and their
Davor Ocelice9ed2812017-12-25 17:49:28 +010013740 available "connslots". Also, whereas "nbsrv" only measures servers that are
Willy Tarreau74ca5042013-06-11 23:12:07 +020013741 actually *down*, this fetch is more fine-grained and looks into the number of
Willy Tarreaua36af912009-10-10 12:02:45 +020013742 available connection slots as well. See also "queue" and "avg_queue".
Jeffrey 'jf' Lim5051d7b2008-09-04 01:03:03 +080013743
Willy Tarreau55165fe2009-05-10 12:02:55 +020013744 OTHER CAVEATS AND NOTES: at this point in time, the code does not take care
13745 of dynamic connections. Also, if any of the server maxconn, or maxqueue is 0,
Willy Tarreau74ca5042013-06-11 23:12:07 +020013746 then this fetch clearly does not make sense, in which case the value returned
Willy Tarreau55165fe2009-05-10 12:02:55 +020013747 will be -1.
Jeffrey 'jf' Lim5051d7b2008-09-04 01:03:03 +080013748
Willy Tarreau6236d3a2013-07-25 14:28:25 +020013749date([<offset>]) : integer
13750 Returns the current date as the epoch (number of seconds since 01/01/1970).
13751 If an offset value is specified, then it is a number of seconds that is added
13752 to the current date before returning the value. This is particularly useful
13753 to compute relative dates, as both positive and negative offsets are allowed.
Willy Tarreau276fae92013-07-25 14:36:01 +020013754 It is useful combined with the http_date converter.
13755
13756 Example :
13757
13758 # set an expires header to now+1 hour in every response
13759 http-response set-header Expires %[date(3600),http_date]
Willy Tarreau6236d3a2013-07-25 14:28:25 +020013760
Etienne Carrierea792a0a2018-01-17 13:43:24 +010013761date_us : integer
13762 Return the microseconds part of the date (the "second" part is returned by
13763 date sample). This sample is coherent with the date sample as it is comes
13764 from the same timeval structure.
13765
Willy Tarreaud716f9b2017-10-13 11:03:15 +020013766distcc_body(<token>[,<occ>]) : binary
13767 Parses a distcc message and returns the body associated to occurrence #<occ>
13768 of the token <token>. Occurrences start at 1, and when unspecified, any may
13769 match though in practice only the first one is checked for now. This can be
13770 used to extract file names or arguments in files built using distcc through
13771 haproxy. Please refer to distcc's protocol documentation for the complete
13772 list of supported tokens.
13773
13774distcc_param(<token>[,<occ>]) : integer
13775 Parses a distcc message and returns the parameter associated to occurrence
13776 #<occ> of the token <token>. Occurrences start at 1, and when unspecified,
13777 any may match though in practice only the first one is checked for now. This
13778 can be used to extract certain information such as the protocol version, the
13779 file size or the argument in files built using distcc through haproxy.
13780 Another use case consists in waiting for the start of the preprocessed file
13781 contents before connecting to the server to avoid keeping idle connections.
13782 Please refer to distcc's protocol documentation for the complete list of
13783 supported tokens.
13784
13785 Example :
13786 # wait up to 20s for the pre-processed file to be uploaded
13787 tcp-request inspect-delay 20s
13788 tcp-request content accept if { distcc_param(DOTI) -m found }
13789 # send large files to the big farm
13790 use_backend big_farm if { distcc_param(DOTI) gt 1000000 }
13791
Willy Tarreau595ec542013-06-12 21:34:28 +020013792env(<name>) : string
13793 Returns a string containing the value of environment variable <name>. As a
13794 reminder, environment variables are per-process and are sampled when the
13795 process starts. This can be useful to pass some information to a next hop
13796 server, or with ACLs to take specific action when the process is started a
13797 certain way.
13798
13799 Examples :
13800 # Pass the Via header to next hop with the local hostname in it
13801 http-request add-header Via 1.1\ %[env(HOSTNAME)]
13802
13803 # reject cookie-less requests when the STOP environment variable is set
13804 http-request deny if !{ cook(SESSIONID) -m found } { env(STOP) -m found }
13805
Willy Tarreau74ca5042013-06-11 23:12:07 +020013806fe_conn([<frontend>]) : integer
13807 Returns the number of currently established connections on the frontend,
Willy Tarreaud63335a2010-02-26 12:56:52 +010013808 possibly including the connection being evaluated. If no frontend name is
13809 specified, the current one is used. But it is also possible to check another
Willy Tarreau74ca5042013-06-11 23:12:07 +020013810 frontend. It can be used to return a sorry page before hard-blocking, or to
13811 use a specific backend to drain new requests when the farm is considered
Davor Ocelice9ed2812017-12-25 17:49:28 +010013812 full. This is mostly used with ACLs but can also be used to pass some
Willy Tarreau74ca5042013-06-11 23:12:07 +020013813 statistics to servers in HTTP headers. See also the "dst_conn", "be_conn",
13814 "fe_sess_rate" fetches.
Willy Tarreaua36af912009-10-10 12:02:45 +020013815
Nenad Merdanovicad9a7e92016-10-03 04:57:37 +020013816fe_req_rate([<frontend>]) : integer
13817 Returns an integer value corresponding to the number of HTTP requests per
13818 second sent to a frontend. This number can differ from "fe_sess_rate" in
13819 situations where client-side keep-alive is enabled.
13820
Willy Tarreau74ca5042013-06-11 23:12:07 +020013821fe_sess_rate([<frontend>]) : integer
13822 Returns an integer value corresponding to the sessions creation rate on the
13823 frontend, in number of new sessions per second. This is used with ACLs to
13824 limit the incoming session rate to an acceptable range in order to prevent
13825 abuse of service at the earliest moment, for example when combined with other
13826 layer 4 ACLs in order to force the clients to wait a bit for the rate to go
13827 down below the limit. It can also be useful to add this element to logs using
13828 a log-format directive. See also the "rate-limit sessions" directive for use
13829 in frontends.
Willy Tarreau079ff0a2009-03-05 21:34:28 +010013830
13831 Example :
13832 # This frontend limits incoming mails to 10/s with a max of 100
13833 # concurrent connections. We accept any connection below 10/s, and
13834 # force excess clients to wait for 100 ms. Since clients are limited to
13835 # 100 max, there cannot be more than 10 incoming mails per second.
13836 frontend mail
13837 bind :25
13838 mode tcp
13839 maxconn 100
13840 acl too_fast fe_sess_rate ge 10
13841 tcp-request inspect-delay 100ms
13842 tcp-request content accept if ! too_fast
13843 tcp-request content accept if WAIT_END
Willy Tarreaud72758d2010-01-12 10:42:19 +010013844
Nenad Merdanovic807a6e72017-03-12 22:00:00 +010013845hostname : string
13846 Returns the system hostname.
13847
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +020013848int(<integer>) : signed integer
13849 Returns a signed integer.
13850
Thierry FOURNIERcc103292015-06-06 19:30:17 +020013851ipv4(<ipv4>) : ipv4
13852 Returns an ipv4.
13853
13854ipv6(<ipv6>) : ipv6
13855 Returns an ipv6.
13856
13857meth(<method>) : method
13858 Returns a method.
13859
Willy Tarreau0f30d262014-11-24 16:02:05 +010013860nbproc : integer
13861 Returns an integer value corresponding to the number of processes that were
13862 started (it equals the global "nbproc" setting). This is useful for logging
13863 and debugging purposes.
13864
Willy Tarreau74ca5042013-06-11 23:12:07 +020013865nbsrv([<backend>]) : integer
13866 Returns an integer value corresponding to the number of usable servers of
13867 either the current backend or the named backend. This is mostly used with
13868 ACLs but can also be useful when added to logs. This is normally used to
Willy Tarreaud63335a2010-02-26 12:56:52 +010013869 switch to an alternate backend when the number of servers is too low to
13870 to handle some load. It is useful to report a failure when combined with
13871 "monitor fail".
Willy Tarreau079ff0a2009-03-05 21:34:28 +010013872
Patrick Hemmerfabb24f2018-08-13 14:07:57 -040013873prio_class : integer
13874 Returns the priority class of the current session for http mode or connection
13875 for tcp mode. The value will be that set by the last call to "http-request
13876 set-priority-class" or "tcp-request content set-priority-class".
13877
13878prio_offset : integer
13879 Returns the priority offset of the current session for http mode or
13880 connection for tcp mode. The value will be that set by the last call to
13881 "http-request set-priority-offset" or "tcp-request content
13882 set-priority-offset".
13883
Willy Tarreau0f30d262014-11-24 16:02:05 +010013884proc : integer
13885 Returns an integer value corresponding to the position of the process calling
13886 the function, between 1 and global.nbproc. This is useful for logging and
13887 debugging purposes.
13888
Willy Tarreau74ca5042013-06-11 23:12:07 +020013889queue([<backend>]) : integer
Willy Tarreaud63335a2010-02-26 12:56:52 +010013890 Returns the total number of queued connections of the designated backend,
13891 including all the connections in server queues. If no backend name is
13892 specified, the current one is used, but it is also possible to check another
Willy Tarreau74ca5042013-06-11 23:12:07 +020013893 one. This is useful with ACLs or to pass statistics to backend servers. This
13894 can be used to take actions when queuing goes above a known level, generally
13895 indicating a surge of traffic or a massive slowdown on the servers. One
13896 possible action could be to reject new users but still accept old ones. See
13897 also the "avg_queue", "be_conn", and "be_sess_rate" fetches.
13898
Willy Tarreau84310e22014-02-14 11:59:04 +010013899rand([<range>]) : integer
13900 Returns a random integer value within a range of <range> possible values,
13901 starting at zero. If the range is not specified, it defaults to 2^32, which
13902 gives numbers between 0 and 4294967295. It can be useful to pass some values
13903 needed to take some routing decisions for example, or just for debugging
13904 purposes. This random must not be used for security purposes.
13905
Willy Tarreau74ca5042013-06-11 23:12:07 +020013906srv_conn([<backend>/]<server>) : integer
13907 Returns an integer value corresponding to the number of currently established
13908 connections on the designated server, possibly including the connection being
13909 evaluated. If <backend> is omitted, then the server is looked up in the
13910 current backend. It can be used to use a specific farm when one server is
13911 full, or to inform the server about our view of the number of active
Patrick Hemmer155e93e2018-06-14 18:01:35 -040013912 connections with it. See also the "fe_conn", "be_conn", "queue", and
13913 "srv_conn_free" fetch methods.
13914
13915srv_conn_free([<backend>/]<server>) : integer
13916 Returns an integer value corresponding to the number of available connections
13917 on the designated server, possibly including the connection being evaluated.
13918 The value does not include queue slots. If <backend> is omitted, then the
13919 server is looked up in the current backend. It can be used to use a specific
13920 farm when one server is full, or to inform the server about our view of the
13921 number of active connections with it. See also the "be_conn_free" and
13922 "srv_conn" fetch methods.
13923
13924 OTHER CAVEATS AND NOTES: If the server maxconn is 0, then this fetch clearly
13925 does not make sense, in which case the value returned will be -1.
Willy Tarreau74ca5042013-06-11 23:12:07 +020013926
13927srv_is_up([<backend>/]<server>) : boolean
13928 Returns true when the designated server is UP, and false when it is either
13929 DOWN or in maintenance mode. If <backend> is omitted, then the server is
13930 looked up in the current backend. It is mainly used to take action based on
Davor Ocelice9ed2812017-12-25 17:49:28 +010013931 an external status reported via a health check (e.g. a geographical site's
Willy Tarreau74ca5042013-06-11 23:12:07 +020013932 availability). Another possible use which is more of a hack consists in
13933 using dummy servers as boolean variables that can be enabled or disabled from
13934 the CLI, so that rules depending on those ACLs can be tweaked in realtime.
13935
Willy Tarreauff2b7af2017-10-13 11:46:26 +020013936srv_queue([<backend>/]<server>) : integer
13937 Returns an integer value corresponding to the number of connections currently
13938 pending in the designated server's queue. If <backend> is omitted, then the
13939 server is looked up in the current backend. It can sometimes be used together
13940 with the "use-server" directive to force to use a known faster server when it
13941 is not much loaded. See also the "srv_conn", "avg_queue" and "queue" sample
13942 fetch methods.
13943
Willy Tarreau74ca5042013-06-11 23:12:07 +020013944srv_sess_rate([<backend>/]<server>) : integer
13945 Returns an integer corresponding to the sessions creation rate on the
13946 designated server, in number of new sessions per second. If <backend> is
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030013947 omitted, then the server is looked up in the current backend. This is mostly
Willy Tarreau74ca5042013-06-11 23:12:07 +020013948 used with ACLs but can make sense with logs too. This is used to switch to an
13949 alternate backend when an expensive or fragile one reaches too high a session
Davor Ocelice9ed2812017-12-25 17:49:28 +010013950 rate, or to limit abuse of service (e.g. prevent latent requests from
Willy Tarreau74ca5042013-06-11 23:12:07 +020013951 overloading servers).
13952
13953 Example :
13954 # Redirect to a separate back
13955 acl srv1_full srv_sess_rate(be1/srv1) gt 50
13956 acl srv2_full srv_sess_rate(be1/srv2) gt 50
13957 use_backend be2 if srv1_full or srv2_full
13958
Willy Tarreau0f30d262014-11-24 16:02:05 +010013959stopping : boolean
13960 Returns TRUE if the process calling the function is currently stopping. This
13961 can be useful for logging, or for relaxing certain checks or helping close
13962 certain connections upon graceful shutdown.
13963
Thierry FOURNIERcc103292015-06-06 19:30:17 +020013964str(<string>) : string
13965 Returns a string.
13966
Willy Tarreau74ca5042013-06-11 23:12:07 +020013967table_avl([<table>]) : integer
13968 Returns the total number of available entries in the current proxy's
13969 stick-table or in the designated stick-table. See also table_cnt.
13970
13971table_cnt([<table>]) : integer
13972 Returns the total number of entries currently in use in the current proxy's
13973 stick-table or in the designated stick-table. See also src_conn_cnt and
13974 table_avl for other entry counting methods.
13975
Christopher Faulet34adb2a2017-11-21 21:45:38 +010013976thread : integer
13977 Returns an integer value corresponding to the position of the thread calling
13978 the function, between 0 and (global.nbthread-1). This is useful for logging
13979 and debugging purposes.
13980
Thierry FOURNIER4834bc72015-06-06 19:29:07 +020013981var(<var-name>) : undefined
13982 Returns a variable with the stored type. If the variable is not set, the
Daniel Schneller0b547052016-03-21 20:46:57 +010013983 sample fetch fails. The name of the variable starts with an indication
13984 about its scope. The scopes allowed are:
Christopher Fauletff2613e2016-11-09 11:36:17 +010013985 "proc" : the variable is shared with the whole process
Daniel Schneller0b547052016-03-21 20:46:57 +010013986 "sess" : the variable is shared with the whole session
13987 "txn" : the variable is shared with the transaction (request and
Thierry FOURNIER4834bc72015-06-06 19:29:07 +020013988 response),
Daniel Schneller0b547052016-03-21 20:46:57 +010013989 "req" : the variable is shared only during request processing,
13990 "res" : the variable is shared only during response processing.
Thierry FOURNIER4834bc72015-06-06 19:29:07 +020013991 This prefix is followed by a name. The separator is a '.'. The name may only
Christopher Fauletb71557a2016-10-31 10:49:03 +010013992 contain characters 'a-z', 'A-Z', '0-9', '.' and '_'.
Thierry FOURNIER4834bc72015-06-06 19:29:07 +020013993
Thierry FOURNIER060762e2014-04-23 13:29:15 +0200139947.3.3. Fetching samples at Layer 4
Willy Tarreau74ca5042013-06-11 23:12:07 +020013995----------------------------------
13996
13997The layer 4 usually describes just the transport layer which in haproxy is
13998closest to the connection, where no content is yet made available. The fetch
13999methods described here are usable as low as the "tcp-request connection" rule
14000sets unless they require some future information. Those generally include
14001TCP/IP addresses and ports, as well as elements from stick-tables related to
Willy Tarreau4d4149c2013-07-23 19:33:46 +020014002the incoming connection. For retrieving a value from a sticky counters, the
14003counter number can be explicitly set as 0, 1, or 2 using the pre-defined
14004"sc0_", "sc1_", or "sc2_" prefix, or it can be specified as the first integer
Willy Tarreau0f791d42013-07-23 19:56:43 +020014005argument when using the "sc_" prefix. An optional table may be specified with
14006the "sc*" form, in which case the currently tracked key will be looked up into
14007this alternate table instead of the table currently being tracked.
Willy Tarreau74ca5042013-06-11 23:12:07 +020014008
14009be_id : integer
14010 Returns an integer containing the current backend's id. It can be used in
14011 frontends with responses to check which backend processed the request.
14012
Marcin Deranekd2471c22016-12-12 14:08:05 +010014013be_name : string
14014 Returns a string containing the current backend's name. It can be used in
14015 frontends with responses to check which backend processed the request.
14016
Willy Tarreau74ca5042013-06-11 23:12:07 +020014017dst : ip
14018 This is the destination IPv4 address of the connection on the client side,
14019 which is the address the client connected to. It can be useful when running
14020 in transparent mode. It is of type IP and works on both IPv4 and IPv6 tables.
14021 On IPv6 tables, IPv4 address is mapped to its IPv6 equivalent, according to
14022 RFC 4291.
14023
14024dst_conn : integer
14025 Returns an integer value corresponding to the number of currently established
14026 connections on the same socket including the one being evaluated. It is
14027 normally used with ACLs but can as well be used to pass the information to
14028 servers in an HTTP header or in logs. It can be used to either return a sorry
14029 page before hard-blocking, or to use a specific backend to drain new requests
14030 when the socket is considered saturated. This offers the ability to assign
14031 different limits to different listening ports or addresses. See also the
14032 "fe_conn" and "be_conn" fetches.
Willy Tarreaud63335a2010-02-26 12:56:52 +010014033
Willy Tarreau16e01562016-08-09 16:46:18 +020014034dst_is_local : boolean
14035 Returns true if the destination address of the incoming connection is local
14036 to the system, or false if the address doesn't exist on the system, meaning
14037 that it was intercepted in transparent mode. It can be useful to apply
14038 certain rules by default to forwarded traffic and other rules to the traffic
Davor Ocelice9ed2812017-12-25 17:49:28 +010014039 targeting the real address of the machine. For example the stats page could
Willy Tarreau16e01562016-08-09 16:46:18 +020014040 be delivered only on this address, or SSH access could be locally redirected.
14041 Please note that the check involves a few system calls, so it's better to do
14042 it only once per connection.
14043
Willy Tarreau74ca5042013-06-11 23:12:07 +020014044dst_port : integer
14045 Returns an integer value corresponding to the destination TCP port of the
14046 connection on the client side, which is the port the client connected to.
14047 This might be used when running in transparent mode, when assigning dynamic
14048 ports to some clients for a whole application session, to stick all users to
14049 a same server, or to pass the destination port information to a server using
14050 an HTTP header.
14051
Willy Tarreau60ca10a2017-08-18 15:26:54 +020014052fc_http_major : integer
14053 Reports the front connection's HTTP major version encoding, which may be 1
14054 for HTTP/0.9 to HTTP/1.1 or 2 for HTTP/2. Note, this is based on the on-wire
14055 encoding and not on the version present in the request header.
14056
Emeric Brun4f603012017-01-05 15:11:44 +010014057fc_rcvd_proxy : boolean
14058 Returns true if the client initiated the connection with a PROXY protocol
14059 header.
14060
Thierry Fournier / OZON.IO6310bef2016-07-24 20:16:50 +020014061fc_rtt(<unit>) : integer
14062 Returns the Round Trip Time (RTT) measured by the kernel for the client
14063 connection. <unit> is facultative, by default the unit is milliseconds. <unit>
14064 can be set to "ms" for milliseconds or "us" for microseconds. If the server
14065 connection is not established, if the connection is not TCP or if the
14066 operating system does not support TCP_INFO, for example Linux kernels before
14067 2.4, the sample fetch fails.
14068
14069fc_rttvar(<unit>) : integer
14070 Returns the Round Trip Time (RTT) variance measured by the kernel for the
14071 client connection. <unit> is facultative, by default the unit is milliseconds.
14072 <unit> can be set to "ms" for milliseconds or "us" for microseconds. If the
14073 server connection is not established, if the connection is not TCP or if the
14074 operating system does not support TCP_INFO, for example Linux kernels before
14075 2.4, the sample fetch fails.
14076
Joe Williams30fcd392016-08-10 07:06:44 -070014077fc_unacked(<unit>) : integer
14078 Returns the unacked counter measured by the kernel for the client connection.
14079 If the server connection is not established, if the connection is not TCP or
14080 if the operating system does not support TCP_INFO, for example Linux kernels
14081 before 2.4, the sample fetch fails.
14082
14083fc_sacked(<unit>) : integer
14084 Returns the sacked counter measured by the kernel for the client connection.
14085 If the server connection is not established, if the connection is not TCP or
14086 if the operating system does not support TCP_INFO, for example Linux kernels
14087 before 2.4, the sample fetch fails.
14088
14089fc_retrans(<unit>) : integer
14090 Returns the retransmits counter measured by the kernel for the client
14091 connection. If the server connection is not established, if the connection is
14092 not TCP or if the operating system does not support TCP_INFO, for example
14093 Linux kernels before 2.4, the sample fetch fails.
14094
14095fc_fackets(<unit>) : integer
14096 Returns the fack counter measured by the kernel for the client
14097 connection. If the server connection is not established, if the connection is
14098 not TCP or if the operating system does not support TCP_INFO, for example
14099 Linux kernels before 2.4, the sample fetch fails.
14100
14101fc_lost(<unit>) : integer
14102 Returns the lost counter measured by the kernel for the client
14103 connection. If the server connection is not established, if the connection is
14104 not TCP or if the operating system does not support TCP_INFO, for example
14105 Linux kernels before 2.4, the sample fetch fails.
14106
14107fc_reordering(<unit>) : integer
14108 Returns the reordering counter measured by the kernel for the client
14109 connection. If the server connection is not established, if the connection is
14110 not TCP or if the operating system does not support TCP_INFO, for example
14111 Linux kernels before 2.4, the sample fetch fails.
14112
Marcin Deranek9a66dfb2018-04-13 14:37:50 +020014113fe_defbe : string
14114 Returns a string containing the frontend's default backend name. It can be
14115 used in frontends to check which backend will handle requests by default.
14116
Willy Tarreau74ca5042013-06-11 23:12:07 +020014117fe_id : integer
14118 Returns an integer containing the current frontend's id. It can be used in
Marcin Deranek6e413ed2016-12-13 12:40:01 +010014119 backends to check from which frontend it was called, or to stick all users
Willy Tarreau74ca5042013-06-11 23:12:07 +020014120 coming via a same frontend to the same server.
14121
Marcin Deranekd2471c22016-12-12 14:08:05 +010014122fe_name : string
14123 Returns a string containing the current frontend's name. It can be used in
14124 backends to check from which frontend it was called, or to stick all users
14125 coming via a same frontend to the same server.
14126
Cyril Bonté62ba8702014-04-22 23:52:25 +020014127sc_bytes_in_rate(<ctr>[,<table>]) : integer
Willy Tarreau0f791d42013-07-23 19:56:43 +020014128sc0_bytes_in_rate([<table>]) : integer
14129sc1_bytes_in_rate([<table>]) : integer
14130sc2_bytes_in_rate([<table>]) : integer
Willy Tarreaue9656522010-08-17 15:40:09 +020014131 Returns the average client-to-server bytes rate from the currently tracked
14132 counters, measured in amount of bytes over the period configured in the
14133 table. See also src_bytes_in_rate.
14134
Cyril Bonté62ba8702014-04-22 23:52:25 +020014135sc_bytes_out_rate(<ctr>[,<table>]) : integer
Willy Tarreau0f791d42013-07-23 19:56:43 +020014136sc0_bytes_out_rate([<table>]) : integer
14137sc1_bytes_out_rate([<table>]) : integer
14138sc2_bytes_out_rate([<table>]) : integer
Willy Tarreaue9656522010-08-17 15:40:09 +020014139 Returns the average server-to-client bytes rate from the currently tracked
14140 counters, measured in amount of bytes over the period configured in the
14141 table. See also src_bytes_out_rate.
14142
Cyril Bonté62ba8702014-04-22 23:52:25 +020014143sc_clr_gpc0(<ctr>[,<table>]) : integer
Willy Tarreau0f791d42013-07-23 19:56:43 +020014144sc0_clr_gpc0([<table>]) : integer
14145sc1_clr_gpc0([<table>]) : integer
14146sc2_clr_gpc0([<table>]) : integer
Willy Tarreauf73cd112011-08-13 01:45:16 +020014147 Clears the first General Purpose Counter associated to the currently tracked
14148 counters, and returns its previous value. Before the first invocation, the
Willy Tarreau869948b2013-01-04 14:14:57 +010014149 stored value is zero, so first invocation will always return zero. This is
14150 typically used as a second ACL in an expression in order to mark a connection
14151 when a first ACL was verified :
Willy Tarreauf73cd112011-08-13 01:45:16 +020014152
Jarno Huuskonen676f6222017-03-30 09:19:45 +030014153 Example:
Willy Tarreauf73cd112011-08-13 01:45:16 +020014154 # block if 5 consecutive requests continue to come faster than 10 sess
14155 # per second, and reset the counter as soon as the traffic slows down.
Willy Tarreaube4a3ef2013-06-17 15:04:07 +020014156 acl abuse sc0_http_req_rate gt 10
14157 acl kill sc0_inc_gpc0 gt 5
14158 acl save sc0_clr_gpc0 ge 0
Willy Tarreauf73cd112011-08-13 01:45:16 +020014159 tcp-request connection accept if !abuse save
14160 tcp-request connection reject if abuse kill
14161
Frédéric Lécaille6778b272018-01-29 15:22:53 +010014162sc_clr_gpc1(<ctr>[,<table>]) : integer
14163sc0_clr_gpc1([<table>]) : integer
14164sc1_clr_gpc1([<table>]) : integer
14165sc2_clr_gpc1([<table>]) : integer
14166 Clears the second General Purpose Counter associated to the currently tracked
14167 counters, and returns its previous value. Before the first invocation, the
14168 stored value is zero, so first invocation will always return zero. This is
14169 typically used as a second ACL in an expression in order to mark a connection
14170 when a first ACL was verified.
14171
Cyril Bonté62ba8702014-04-22 23:52:25 +020014172sc_conn_cnt(<ctr>[,<table>]) : integer
Willy Tarreau0f791d42013-07-23 19:56:43 +020014173sc0_conn_cnt([<table>]) : integer
14174sc1_conn_cnt([<table>]) : integer
14175sc2_conn_cnt([<table>]) : integer
Davor Ocelice9ed2812017-12-25 17:49:28 +010014176 Returns the cumulative number of incoming connections from currently tracked
Willy Tarreaue9656522010-08-17 15:40:09 +020014177 counters. See also src_conn_cnt.
14178
Cyril Bonté62ba8702014-04-22 23:52:25 +020014179sc_conn_cur(<ctr>[,<table>]) : integer
Willy Tarreau0f791d42013-07-23 19:56:43 +020014180sc0_conn_cur([<table>]) : integer
14181sc1_conn_cur([<table>]) : integer
14182sc2_conn_cur([<table>]) : integer
Willy Tarreaue9656522010-08-17 15:40:09 +020014183 Returns the current amount of concurrent connections tracking the same
14184 tracked counters. This number is automatically incremented when tracking
14185 begins and decremented when tracking stops. See also src_conn_cur.
14186
Cyril Bonté62ba8702014-04-22 23:52:25 +020014187sc_conn_rate(<ctr>[,<table>]) : integer
Willy Tarreau0f791d42013-07-23 19:56:43 +020014188sc0_conn_rate([<table>]) : integer
14189sc1_conn_rate([<table>]) : integer
14190sc2_conn_rate([<table>]) : integer
Willy Tarreaue9656522010-08-17 15:40:09 +020014191 Returns the average connection rate from the currently tracked counters,
14192 measured in amount of connections over the period configured in the table.
14193 See also src_conn_rate.
14194
Cyril Bonté62ba8702014-04-22 23:52:25 +020014195sc_get_gpc0(<ctr>[,<table>]) : integer
Willy Tarreau0f791d42013-07-23 19:56:43 +020014196sc0_get_gpc0([<table>]) : integer
14197sc1_get_gpc0([<table>]) : integer
14198sc2_get_gpc0([<table>]) : integer
Willy Tarreaue9656522010-08-17 15:40:09 +020014199 Returns the value of the first General Purpose Counter associated to the
Willy Tarreau4d4149c2013-07-23 19:33:46 +020014200 currently tracked counters. See also src_get_gpc0 and sc/sc0/sc1/sc2_inc_gpc0.
Willy Tarreauba2ffd12013-05-29 15:54:14 +020014201
Frédéric Lécaille6778b272018-01-29 15:22:53 +010014202sc_get_gpc1(<ctr>[,<table>]) : integer
14203sc0_get_gpc1([<table>]) : integer
14204sc1_get_gpc1([<table>]) : integer
14205sc2_get_gpc1([<table>]) : integer
14206 Returns the value of the second General Purpose Counter associated to the
14207 currently tracked counters. See also src_get_gpc1 and sc/sc0/sc1/sc2_inc_gpc1.
14208
Thierry FOURNIER236657b2015-08-19 08:25:14 +020014209sc_get_gpt0(<ctr>[,<table>]) : integer
14210sc0_get_gpt0([<table>]) : integer
14211sc1_get_gpt0([<table>]) : integer
14212sc2_get_gpt0([<table>]) : integer
14213 Returns the value of the first General Purpose Tag associated to the
14214 currently tracked counters. See also src_get_gpt0.
14215
Cyril Bonté62ba8702014-04-22 23:52:25 +020014216sc_gpc0_rate(<ctr>[,<table>]) : integer
Willy Tarreau0f791d42013-07-23 19:56:43 +020014217sc0_gpc0_rate([<table>]) : integer
14218sc1_gpc0_rate([<table>]) : integer
14219sc2_gpc0_rate([<table>]) : integer
Willy Tarreauba2ffd12013-05-29 15:54:14 +020014220 Returns the average increment rate of the first General Purpose Counter
14221 associated to the currently tracked counters. It reports the frequency
14222 which the gpc0 counter was incremented over the configured period. See also
Willy Tarreau4d4149c2013-07-23 19:33:46 +020014223 src_gpc0_rate, sc/sc0/sc1/sc2_get_gpc0, and sc/sc0/sc1/sc2_inc_gpc0. Note
14224 that the "gpc0_rate" counter must be stored in the stick-table for a value to
14225 be returned, as "gpc0" only holds the event count.
Willy Tarreaue9656522010-08-17 15:40:09 +020014226
Frédéric Lécaille6778b272018-01-29 15:22:53 +010014227sc_gpc1_rate(<ctr>[,<table>]) : integer
14228sc0_gpc1_rate([<table>]) : integer
14229sc1_gpc1_rate([<table>]) : integer
14230sc2_gpc1_rate([<table>]) : integer
14231 Returns the average increment rate of the second General Purpose Counter
14232 associated to the currently tracked counters. It reports the frequency
14233 which the gpc1 counter was incremented over the configured period. See also
14234 src_gpcA_rate, sc/sc0/sc1/sc2_get_gpc1, and sc/sc0/sc1/sc2_inc_gpc1. Note
14235 that the "gpc1_rate" counter must be stored in the stick-table for a value to
14236 be returned, as "gpc1" only holds the event count.
14237
Cyril Bonté62ba8702014-04-22 23:52:25 +020014238sc_http_err_cnt(<ctr>[,<table>]) : integer
Willy Tarreau0f791d42013-07-23 19:56:43 +020014239sc0_http_err_cnt([<table>]) : integer
14240sc1_http_err_cnt([<table>]) : integer
14241sc2_http_err_cnt([<table>]) : integer
Davor Ocelice9ed2812017-12-25 17:49:28 +010014242 Returns the cumulative number of HTTP errors from the currently tracked
Willy Tarreaue9656522010-08-17 15:40:09 +020014243 counters. This includes the both request errors and 4xx error responses.
14244 See also src_http_err_cnt.
14245
Cyril Bonté62ba8702014-04-22 23:52:25 +020014246sc_http_err_rate(<ctr>[,<table>]) : integer
Willy Tarreau0f791d42013-07-23 19:56:43 +020014247sc0_http_err_rate([<table>]) : integer
14248sc1_http_err_rate([<table>]) : integer
14249sc2_http_err_rate([<table>]) : integer
Willy Tarreaue9656522010-08-17 15:40:09 +020014250 Returns the average rate of HTTP errors from the currently tracked counters,
14251 measured in amount of errors over the period configured in the table. This
14252 includes the both request errors and 4xx error responses. See also
14253 src_http_err_rate.
14254
Cyril Bonté62ba8702014-04-22 23:52:25 +020014255sc_http_req_cnt(<ctr>[,<table>]) : integer
Willy Tarreau0f791d42013-07-23 19:56:43 +020014256sc0_http_req_cnt([<table>]) : integer
14257sc1_http_req_cnt([<table>]) : integer
14258sc2_http_req_cnt([<table>]) : integer
Davor Ocelice9ed2812017-12-25 17:49:28 +010014259 Returns the cumulative number of HTTP requests from the currently tracked
Willy Tarreaue9656522010-08-17 15:40:09 +020014260 counters. This includes every started request, valid or not. See also
14261 src_http_req_cnt.
14262
Cyril Bonté62ba8702014-04-22 23:52:25 +020014263sc_http_req_rate(<ctr>[,<table>]) : integer
Willy Tarreau0f791d42013-07-23 19:56:43 +020014264sc0_http_req_rate([<table>]) : integer
14265sc1_http_req_rate([<table>]) : integer
14266sc2_http_req_rate([<table>]) : integer
Willy Tarreaue9656522010-08-17 15:40:09 +020014267 Returns the average rate of HTTP requests from the currently tracked
14268 counters, measured in amount of requests over the period configured in
14269 the table. This includes every started request, valid or not. See also
14270 src_http_req_rate.
14271
Cyril Bonté62ba8702014-04-22 23:52:25 +020014272sc_inc_gpc0(<ctr>[,<table>]) : integer
Willy Tarreau0f791d42013-07-23 19:56:43 +020014273sc0_inc_gpc0([<table>]) : integer
14274sc1_inc_gpc0([<table>]) : integer
14275sc2_inc_gpc0([<table>]) : integer
Willy Tarreaue9656522010-08-17 15:40:09 +020014276 Increments the first General Purpose Counter associated to the currently
Willy Tarreau869948b2013-01-04 14:14:57 +010014277 tracked counters, and returns its new value. Before the first invocation,
14278 the stored value is zero, so first invocation will increase it to 1 and will
14279 return 1. This is typically used as a second ACL in an expression in order
14280 to mark a connection when a first ACL was verified :
Willy Tarreaue9656522010-08-17 15:40:09 +020014281
Jarno Huuskonen676f6222017-03-30 09:19:45 +030014282 Example:
Willy Tarreaube4a3ef2013-06-17 15:04:07 +020014283 acl abuse sc0_http_req_rate gt 10
14284 acl kill sc0_inc_gpc0 gt 0
Willy Tarreaue9656522010-08-17 15:40:09 +020014285 tcp-request connection reject if abuse kill
14286
Frédéric Lécaille6778b272018-01-29 15:22:53 +010014287sc_inc_gpc1(<ctr>[,<table>]) : integer
14288sc0_inc_gpc1([<table>]) : integer
14289sc1_inc_gpc1([<table>]) : integer
14290sc2_inc_gpc1([<table>]) : integer
14291 Increments the second General Purpose Counter associated to the currently
14292 tracked counters, and returns its new value. Before the first invocation,
14293 the stored value is zero, so first invocation will increase it to 1 and will
14294 return 1. This is typically used as a second ACL in an expression in order
14295 to mark a connection when a first ACL was verified.
14296
Cyril Bonté62ba8702014-04-22 23:52:25 +020014297sc_kbytes_in(<ctr>[,<table>]) : integer
Willy Tarreau0f791d42013-07-23 19:56:43 +020014298sc0_kbytes_in([<table>]) : integer
14299sc1_kbytes_in([<table>]) : integer
14300sc2_kbytes_in([<table>]) : integer
Willy Tarreaua01b9742014-07-10 15:29:24 +020014301 Returns the total amount of client-to-server data from the currently tracked
14302 counters, measured in kilobytes. The test is currently performed on 32-bit
14303 integers, which limits values to 4 terabytes. See also src_kbytes_in.
Willy Tarreaue9656522010-08-17 15:40:09 +020014304
Cyril Bonté62ba8702014-04-22 23:52:25 +020014305sc_kbytes_out(<ctr>[,<table>]) : integer
Willy Tarreau0f791d42013-07-23 19:56:43 +020014306sc0_kbytes_out([<table>]) : integer
14307sc1_kbytes_out([<table>]) : integer
14308sc2_kbytes_out([<table>]) : integer
Willy Tarreaua01b9742014-07-10 15:29:24 +020014309 Returns the total amount of server-to-client data from the currently tracked
14310 counters, measured in kilobytes. The test is currently performed on 32-bit
14311 integers, which limits values to 4 terabytes. See also src_kbytes_out.
Willy Tarreaue9656522010-08-17 15:40:09 +020014312
Cyril Bonté62ba8702014-04-22 23:52:25 +020014313sc_sess_cnt(<ctr>[,<table>]) : integer
Willy Tarreau0f791d42013-07-23 19:56:43 +020014314sc0_sess_cnt([<table>]) : integer
14315sc1_sess_cnt([<table>]) : integer
14316sc2_sess_cnt([<table>]) : integer
Davor Ocelice9ed2812017-12-25 17:49:28 +010014317 Returns the cumulative number of incoming connections that were transformed
Willy Tarreaue9656522010-08-17 15:40:09 +020014318 into sessions, which means that they were accepted by a "tcp-request
14319 connection" rule, from the currently tracked counters. A backend may count
14320 more sessions than connections because each connection could result in many
Jamie Gloudonaaa21002012-08-25 00:18:33 -040014321 backend sessions if some HTTP keep-alive is performed over the connection
Willy Tarreaue9656522010-08-17 15:40:09 +020014322 with the client. See also src_sess_cnt.
14323
Cyril Bonté62ba8702014-04-22 23:52:25 +020014324sc_sess_rate(<ctr>[,<table>]) : integer
Willy Tarreau0f791d42013-07-23 19:56:43 +020014325sc0_sess_rate([<table>]) : integer
14326sc1_sess_rate([<table>]) : integer
14327sc2_sess_rate([<table>]) : integer
Willy Tarreaue9656522010-08-17 15:40:09 +020014328 Returns the average session rate from the currently tracked counters,
14329 measured in amount of sessions over the period configured in the table. A
14330 session is a connection that got past the early "tcp-request connection"
14331 rules. A backend may count more sessions than connections because each
14332 connection could result in many backend sessions if some HTTP keep-alive is
Jamie Gloudonaaa21002012-08-25 00:18:33 -040014333 performed over the connection with the client. See also src_sess_rate.
Willy Tarreaue9656522010-08-17 15:40:09 +020014334
Cyril Bonté62ba8702014-04-22 23:52:25 +020014335sc_tracked(<ctr>[,<table>]) : boolean
Willy Tarreau0f791d42013-07-23 19:56:43 +020014336sc0_tracked([<table>]) : boolean
14337sc1_tracked([<table>]) : boolean
14338sc2_tracked([<table>]) : boolean
Willy Tarreau6f1615f2013-06-03 15:15:22 +020014339 Returns true if the designated session counter is currently being tracked by
14340 the current session. This can be useful when deciding whether or not we want
14341 to set some values in a header passed to the server.
14342
Cyril Bonté62ba8702014-04-22 23:52:25 +020014343sc_trackers(<ctr>[,<table>]) : integer
Willy Tarreau0f791d42013-07-23 19:56:43 +020014344sc0_trackers([<table>]) : integer
14345sc1_trackers([<table>]) : integer
14346sc2_trackers([<table>]) : integer
Willy Tarreau2406db42012-12-09 12:16:43 +010014347 Returns the current amount of concurrent connections tracking the same
14348 tracked counters. This number is automatically incremented when tracking
Willy Tarreaube4a3ef2013-06-17 15:04:07 +020014349 begins and decremented when tracking stops. It differs from sc0_conn_cur in
Willy Tarreau2406db42012-12-09 12:16:43 +010014350 that it does not rely on any stored information but on the table's reference
14351 count (the "use" value which is returned by "show table" on the CLI). This
Willy Tarreau74ca5042013-06-11 23:12:07 +020014352 may sometimes be more suited for layer7 tracking. It can be used to tell a
14353 server how many concurrent connections there are from a given address for
14354 example.
Willy Tarreau2406db42012-12-09 12:16:43 +010014355
Willy Tarreau74ca5042013-06-11 23:12:07 +020014356so_id : integer
14357 Returns an integer containing the current listening socket's id. It is useful
14358 in frontends involving many "bind" lines, or to stick all users coming via a
14359 same socket to the same server.
Willy Tarreaud63335a2010-02-26 12:56:52 +010014360
Willy Tarreau74ca5042013-06-11 23:12:07 +020014361src : ip
Davor Ocelice9ed2812017-12-25 17:49:28 +010014362 This is the source IPv4 address of the client of the session. It is of type
Willy Tarreau74ca5042013-06-11 23:12:07 +020014363 IP and works on both IPv4 and IPv6 tables. On IPv6 tables, IPv4 addresses are
14364 mapped to their IPv6 equivalent, according to RFC 4291. Note that it is the
14365 TCP-level source address which is used, and not the address of a client
Bertrand Jacquin93b227d2016-06-04 15:11:10 +010014366 behind a proxy. However if the "accept-proxy" or "accept-netscaler-cip" bind
14367 directive is used, it can be the address of a client behind another
14368 PROXY-protocol compatible component for all rule sets except
14369 "tcp-request connection" which sees the real address.
Willy Tarreaud63335a2010-02-26 12:56:52 +010014370
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010014371 Example:
14372 # add an HTTP header in requests with the originating address' country
14373 http-request set-header X-Country %[src,map_ip(geoip.lst)]
14374
Willy Tarreau74ca5042013-06-11 23:12:07 +020014375src_bytes_in_rate([<table>]) : integer
14376 Returns the average bytes rate from the incoming connection's source address
14377 in the current proxy's stick-table or in the designated stick-table, measured
14378 in amount of bytes over the period configured in the table. If the address is
Willy Tarreau4d4149c2013-07-23 19:33:46 +020014379 not found, zero is returned. See also sc/sc0/sc1/sc2_bytes_in_rate.
Willy Tarreauc9705a12010-07-27 20:05:50 +020014380
Willy Tarreau74ca5042013-06-11 23:12:07 +020014381src_bytes_out_rate([<table>]) : integer
14382 Returns the average bytes rate to the incoming connection's source address in
14383 the current proxy's stick-table or in the designated stick-table, measured in
Willy Tarreauc9705a12010-07-27 20:05:50 +020014384 amount of bytes over the period configured in the table. If the address is
Willy Tarreau4d4149c2013-07-23 19:33:46 +020014385 not found, zero is returned. See also sc/sc0/sc1/sc2_bytes_out_rate.
Willy Tarreauc9705a12010-07-27 20:05:50 +020014386
Willy Tarreau74ca5042013-06-11 23:12:07 +020014387src_clr_gpc0([<table>]) : integer
14388 Clears the first General Purpose Counter associated to the incoming
14389 connection's source address in the current proxy's stick-table or in the
14390 designated stick-table, and returns its previous value. If the address is not
14391 found, an entry is created and 0 is returned. This is typically used as a
14392 second ACL in an expression in order to mark a connection when a first ACL
14393 was verified :
Willy Tarreauf73cd112011-08-13 01:45:16 +020014394
Jarno Huuskonen676f6222017-03-30 09:19:45 +030014395 Example:
Willy Tarreauf73cd112011-08-13 01:45:16 +020014396 # block if 5 consecutive requests continue to come faster than 10 sess
14397 # per second, and reset the counter as soon as the traffic slows down.
14398 acl abuse src_http_req_rate gt 10
14399 acl kill src_inc_gpc0 gt 5
Willy Tarreau869948b2013-01-04 14:14:57 +010014400 acl save src_clr_gpc0 ge 0
Willy Tarreauf73cd112011-08-13 01:45:16 +020014401 tcp-request connection accept if !abuse save
14402 tcp-request connection reject if abuse kill
14403
Frédéric Lécaille6778b272018-01-29 15:22:53 +010014404src_clr_gpc1([<table>]) : integer
14405 Clears the second General Purpose Counter associated to the incoming
14406 connection's source address in the current proxy's stick-table or in the
14407 designated stick-table, and returns its previous value. If the address is not
14408 found, an entry is created and 0 is returned. This is typically used as a
14409 second ACL in an expression in order to mark a connection when a first ACL
14410 was verified.
14411
Willy Tarreau74ca5042013-06-11 23:12:07 +020014412src_conn_cnt([<table>]) : integer
Davor Ocelice9ed2812017-12-25 17:49:28 +010014413 Returns the cumulative number of connections initiated from the current
Willy Tarreau74ca5042013-06-11 23:12:07 +020014414 incoming connection's source address in the current proxy's stick-table or in
Willy Tarreauc9705a12010-07-27 20:05:50 +020014415 the designated stick-table. If the address is not found, zero is returned.
Willy Tarreau4d4149c2013-07-23 19:33:46 +020014416 See also sc/sc0/sc1/sc2_conn_cnt.
Willy Tarreauc9705a12010-07-27 20:05:50 +020014417
Willy Tarreau74ca5042013-06-11 23:12:07 +020014418src_conn_cur([<table>]) : integer
Willy Tarreauc9705a12010-07-27 20:05:50 +020014419 Returns the current amount of concurrent connections initiated from the
Willy Tarreau74ca5042013-06-11 23:12:07 +020014420 current incoming connection's source address in the current proxy's
14421 stick-table or in the designated stick-table. If the address is not found,
Willy Tarreau4d4149c2013-07-23 19:33:46 +020014422 zero is returned. See also sc/sc0/sc1/sc2_conn_cur.
Willy Tarreauc9705a12010-07-27 20:05:50 +020014423
Willy Tarreau74ca5042013-06-11 23:12:07 +020014424src_conn_rate([<table>]) : integer
14425 Returns the average connection rate from the incoming connection's source
14426 address in the current proxy's stick-table or in the designated stick-table,
14427 measured in amount of connections over the period configured in the table. If
Willy Tarreau4d4149c2013-07-23 19:33:46 +020014428 the address is not found, zero is returned. See also sc/sc0/sc1/sc2_conn_rate.
Willy Tarreauc9705a12010-07-27 20:05:50 +020014429
Willy Tarreau74ca5042013-06-11 23:12:07 +020014430src_get_gpc0([<table>]) : integer
Willy Tarreauc9705a12010-07-27 20:05:50 +020014431 Returns the value of the first General Purpose Counter associated to the
Willy Tarreau74ca5042013-06-11 23:12:07 +020014432 incoming connection's source address in the current proxy's stick-table or in
Willy Tarreauc9705a12010-07-27 20:05:50 +020014433 the designated stick-table. If the address is not found, zero is returned.
Willy Tarreau4d4149c2013-07-23 19:33:46 +020014434 See also sc/sc0/sc1/sc2_get_gpc0 and src_inc_gpc0.
Willy Tarreauc9705a12010-07-27 20:05:50 +020014435
Frédéric Lécaille6778b272018-01-29 15:22:53 +010014436src_get_gpc1([<table>]) : integer
14437 Returns the value of the second General Purpose Counter associated to the
14438 incoming connection's source address in the current proxy's stick-table or in
14439 the designated stick-table. If the address is not found, zero is returned.
14440 See also sc/sc0/sc1/sc2_get_gpc1 and src_inc_gpc1.
14441
Thierry FOURNIER236657b2015-08-19 08:25:14 +020014442src_get_gpt0([<table>]) : integer
14443 Returns the value of the first General Purpose Tag associated to the
14444 incoming connection's source address in the current proxy's stick-table or in
14445 the designated stick-table. If the address is not found, zero is returned.
14446 See also sc/sc0/sc1/sc2_get_gpt0.
14447
Willy Tarreau74ca5042013-06-11 23:12:07 +020014448src_gpc0_rate([<table>]) : integer
Willy Tarreauba2ffd12013-05-29 15:54:14 +020014449 Returns the average increment rate of the first General Purpose Counter
Willy Tarreau74ca5042013-06-11 23:12:07 +020014450 associated to the incoming connection's source address in the current proxy's
Willy Tarreauba2ffd12013-05-29 15:54:14 +020014451 stick-table or in the designated stick-table. It reports the frequency
14452 which the gpc0 counter was incremented over the configured period. See also
Willy Tarreau4d4149c2013-07-23 19:33:46 +020014453 sc/sc0/sc1/sc2_gpc0_rate, src_get_gpc0, and sc/sc0/sc1/sc2_inc_gpc0. Note
14454 that the "gpc0_rate" counter must be stored in the stick-table for a value to
14455 be returned, as "gpc0" only holds the event count.
Willy Tarreauba2ffd12013-05-29 15:54:14 +020014456
Frédéric Lécaille6778b272018-01-29 15:22:53 +010014457src_gpc1_rate([<table>]) : integer
14458 Returns the average increment rate of the second General Purpose Counter
14459 associated to the incoming connection's source address in the current proxy's
14460 stick-table or in the designated stick-table. It reports the frequency
14461 which the gpc1 counter was incremented over the configured period. See also
14462 sc/sc0/sc1/sc2_gpc1_rate, src_get_gpc1, and sc/sc0/sc1/sc2_inc_gpc1. Note
14463 that the "gpc1_rate" counter must be stored in the stick-table for a value to
14464 be returned, as "gpc1" only holds the event count.
14465
Willy Tarreau74ca5042013-06-11 23:12:07 +020014466src_http_err_cnt([<table>]) : integer
Davor Ocelice9ed2812017-12-25 17:49:28 +010014467 Returns the cumulative number of HTTP errors from the incoming connection's
Willy Tarreau74ca5042013-06-11 23:12:07 +020014468 source address in the current proxy's stick-table or in the designated
Willy Tarreauc9705a12010-07-27 20:05:50 +020014469 stick-table. This includes the both request errors and 4xx error responses.
Willy Tarreau4d4149c2013-07-23 19:33:46 +020014470 See also sc/sc0/sc1/sc2_http_err_cnt. If the address is not found, zero is
Willy Tarreau74ca5042013-06-11 23:12:07 +020014471 returned.
Willy Tarreauc9705a12010-07-27 20:05:50 +020014472
Willy Tarreau74ca5042013-06-11 23:12:07 +020014473src_http_err_rate([<table>]) : integer
14474 Returns the average rate of HTTP errors from the incoming connection's source
14475 address in the current proxy's stick-table or in the designated stick-table,
14476 measured in amount of errors over the period configured in the table. This
14477 includes the both request errors and 4xx error responses. If the address is
Willy Tarreau4d4149c2013-07-23 19:33:46 +020014478 not found, zero is returned. See also sc/sc0/sc1/sc2_http_err_rate.
Willy Tarreauc9705a12010-07-27 20:05:50 +020014479
Willy Tarreau74ca5042013-06-11 23:12:07 +020014480src_http_req_cnt([<table>]) : integer
Davor Ocelice9ed2812017-12-25 17:49:28 +010014481 Returns the cumulative number of HTTP requests from the incoming connection's
Willy Tarreau74ca5042013-06-11 23:12:07 +020014482 source address in the current proxy's stick-table or in the designated stick-
14483 table. This includes every started request, valid or not. If the address is
Willy Tarreau4d4149c2013-07-23 19:33:46 +020014484 not found, zero is returned. See also sc/sc0/sc1/sc2_http_req_cnt.
Willy Tarreauc9705a12010-07-27 20:05:50 +020014485
Willy Tarreau74ca5042013-06-11 23:12:07 +020014486src_http_req_rate([<table>]) : integer
14487 Returns the average rate of HTTP requests from the incoming connection's
14488 source address in the current proxy's stick-table or in the designated stick-
14489 table, measured in amount of requests over the period configured in the
Willy Tarreauc9705a12010-07-27 20:05:50 +020014490 table. This includes every started request, valid or not. If the address is
Willy Tarreau4d4149c2013-07-23 19:33:46 +020014491 not found, zero is returned. See also sc/sc0/sc1/sc2_http_req_rate.
Willy Tarreauc9705a12010-07-27 20:05:50 +020014492
Willy Tarreau74ca5042013-06-11 23:12:07 +020014493src_inc_gpc0([<table>]) : integer
14494 Increments the first General Purpose Counter associated to the incoming
14495 connection's source address in the current proxy's stick-table or in the
14496 designated stick-table, and returns its new value. If the address is not
Willy Tarreaube4a3ef2013-06-17 15:04:07 +020014497 found, an entry is created and 1 is returned. See also sc0/sc2/sc2_inc_gpc0.
Willy Tarreau74ca5042013-06-11 23:12:07 +020014498 This is typically used as a second ACL in an expression in order to mark a
14499 connection when a first ACL was verified :
Willy Tarreauc9705a12010-07-27 20:05:50 +020014500
Jarno Huuskonen676f6222017-03-30 09:19:45 +030014501 Example:
Willy Tarreauc9705a12010-07-27 20:05:50 +020014502 acl abuse src_http_req_rate gt 10
Willy Tarreau869948b2013-01-04 14:14:57 +010014503 acl kill src_inc_gpc0 gt 0
Willy Tarreaue9656522010-08-17 15:40:09 +020014504 tcp-request connection reject if abuse kill
Willy Tarreauc9705a12010-07-27 20:05:50 +020014505
Frédéric Lécaille6778b272018-01-29 15:22:53 +010014506src_inc_gpc1([<table>]) : integer
14507 Increments the second General Purpose Counter associated to the incoming
14508 connection's source address in the current proxy's stick-table or in the
14509 designated stick-table, and returns its new value. If the address is not
14510 found, an entry is created and 1 is returned. See also sc0/sc2/sc2_inc_gpc1.
14511 This is typically used as a second ACL in an expression in order to mark a
14512 connection when a first ACL was verified.
14513
Willy Tarreau16e01562016-08-09 16:46:18 +020014514src_is_local : boolean
14515 Returns true if the source address of the incoming connection is local to the
14516 system, or false if the address doesn't exist on the system, meaning that it
14517 comes from a remote machine. Note that UNIX addresses are considered local.
14518 It can be useful to apply certain access restrictions based on where the
Davor Ocelice9ed2812017-12-25 17:49:28 +010014519 client comes from (e.g. require auth or https for remote machines). Please
Willy Tarreau16e01562016-08-09 16:46:18 +020014520 note that the check involves a few system calls, so it's better to do it only
14521 once per connection.
14522
Willy Tarreau74ca5042013-06-11 23:12:07 +020014523src_kbytes_in([<table>]) : integer
Willy Tarreaua01b9742014-07-10 15:29:24 +020014524 Returns the total amount of data received from the incoming connection's
14525 source address in the current proxy's stick-table or in the designated
14526 stick-table, measured in kilobytes. If the address is not found, zero is
14527 returned. The test is currently performed on 32-bit integers, which limits
14528 values to 4 terabytes. See also sc/sc0/sc1/sc2_kbytes_in.
Willy Tarreauc9705a12010-07-27 20:05:50 +020014529
Willy Tarreau74ca5042013-06-11 23:12:07 +020014530src_kbytes_out([<table>]) : integer
Willy Tarreaua01b9742014-07-10 15:29:24 +020014531 Returns the total amount of data sent to the incoming connection's source
14532 address in the current proxy's stick-table or in the designated stick-table,
14533 measured in kilobytes. If the address is not found, zero is returned. The
14534 test is currently performed on 32-bit integers, which limits values to 4
14535 terabytes. See also sc/sc0/sc1/sc2_kbytes_out.
Willy Tarreaua975b8f2010-06-05 19:13:27 +020014536
Willy Tarreau74ca5042013-06-11 23:12:07 +020014537src_port : integer
14538 Returns an integer value corresponding to the TCP source port of the
14539 connection on the client side, which is the port the client connected from.
14540 Usage of this function is very limited as modern protocols do not care much
14541 about source ports nowadays.
Willy Tarreau079ff0a2009-03-05 21:34:28 +010014542
Willy Tarreau74ca5042013-06-11 23:12:07 +020014543src_sess_cnt([<table>]) : integer
Davor Ocelice9ed2812017-12-25 17:49:28 +010014544 Returns the cumulative number of connections initiated from the incoming
Willy Tarreauc9705a12010-07-27 20:05:50 +020014545 connection's source IPv4 address in the current proxy's stick-table or in the
14546 designated stick-table, that were transformed into sessions, which means that
14547 they were accepted by "tcp-request" rules. If the address is not found, zero
Willy Tarreau4d4149c2013-07-23 19:33:46 +020014548 is returned. See also sc/sc0/sc1/sc2_sess_cnt.
Willy Tarreauc9705a12010-07-27 20:05:50 +020014549
Willy Tarreau74ca5042013-06-11 23:12:07 +020014550src_sess_rate([<table>]) : integer
14551 Returns the average session rate from the incoming connection's source
14552 address in the current proxy's stick-table or in the designated stick-table,
14553 measured in amount of sessions over the period configured in the table. A
14554 session is a connection that went past the early "tcp-request" rules. If the
Willy Tarreau4d4149c2013-07-23 19:33:46 +020014555 address is not found, zero is returned. See also sc/sc0/sc1/sc2_sess_rate.
Willy Tarreauc9705a12010-07-27 20:05:50 +020014556
Willy Tarreau74ca5042013-06-11 23:12:07 +020014557src_updt_conn_cnt([<table>]) : integer
14558 Creates or updates the entry associated to the incoming connection's source
14559 address in the current proxy's stick-table or in the designated stick-table.
14560 This table must be configured to store the "conn_cnt" data type, otherwise
14561 the match will be ignored. The current count is incremented by one, and the
14562 expiration timer refreshed. The updated count is returned, so this match
14563 can't return zero. This was used to reject service abusers based on their
14564 source address. Note: it is recommended to use the more complete "track-sc*"
14565 actions in "tcp-request" rules instead.
Willy Tarreaua975b8f2010-06-05 19:13:27 +020014566
14567 Example :
14568 # This frontend limits incoming SSH connections to 3 per 10 second for
14569 # each source address, and rejects excess connections until a 10 second
14570 # silence is observed. At most 20 addresses are tracked.
14571 listen ssh
14572 bind :22
14573 mode tcp
14574 maxconn 100
Willy Tarreauc9705a12010-07-27 20:05:50 +020014575 stick-table type ip size 20 expire 10s store conn_cnt
Willy Tarreau74ca5042013-06-11 23:12:07 +020014576 tcp-request content reject if { src_updt_conn_cnt gt 3 }
Willy Tarreaua975b8f2010-06-05 19:13:27 +020014577 server local 127.0.0.1:22
14578
Willy Tarreau74ca5042013-06-11 23:12:07 +020014579srv_id : integer
14580 Returns an integer containing the server's id when processing the response.
14581 While it's almost only used with ACLs, it may be used for logging or
14582 debugging.
Hervé COMMOWICKdaa824e2011-08-05 12:09:44 +020014583
Thierry FOURNIER060762e2014-04-23 13:29:15 +0200145847.3.4. Fetching samples at Layer 5
Willy Tarreau74ca5042013-06-11 23:12:07 +020014585----------------------------------
Willy Tarreau0b1cd942010-05-16 22:18:27 +020014586
Willy Tarreau74ca5042013-06-11 23:12:07 +020014587The layer 5 usually describes just the session layer which in haproxy is
14588closest to the session once all the connection handshakes are finished, but
14589when no content is yet made available. The fetch methods described here are
14590usable as low as the "tcp-request content" rule sets unless they require some
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030014591future information. Those generally include the results of SSL negotiations.
Willy Tarreauc735a072011-03-29 00:57:02 +020014592
Ben Shillitof25e8e52016-12-02 14:25:37 +00001459351d.all(<prop>[,<prop>*]) : string
14594 Returns values for the properties requested as a string, where values are
14595 separated by the delimiter specified with "51degrees-property-separator".
14596 The device is identified using all the important HTTP headers from the
14597 request. The function can be passed up to five property names, and if a
14598 property name can't be found, the value "NoData" is returned.
14599
14600 Example :
14601 # Here the header "X-51D-DeviceTypeMobileTablet" is added to the request
14602 # containing the three properties requested using all relevant headers from
14603 # the request.
14604 frontend http-in
14605 bind *:8081
14606 default_backend servers
14607 http-request set-header X-51D-DeviceTypeMobileTablet \
14608 %[51d.all(DeviceType,IsMobile,IsTablet)]
14609
Emeric Brun645ae792014-04-30 14:21:06 +020014610ssl_bc : boolean
14611 Returns true when the back connection was made via an SSL/TLS transport
14612 layer and is locally deciphered. This means the outgoing connection was made
14613 other a server with the "ssl" option.
14614
14615ssl_bc_alg_keysize : integer
14616 Returns the symmetric cipher key size supported in bits when the outgoing
14617 connection was made over an SSL/TLS transport layer.
14618
14619ssl_bc_cipher : string
14620 Returns the name of the used cipher when the outgoing connection was made
14621 over an SSL/TLS transport layer.
14622
Emeric Brun74f7ffa2018-02-19 16:14:12 +010014623ssl_bc_is_resumed : boolean
14624 Returns true when the back connection was made over an SSL/TLS transport
14625 layer and the newly created SSL session was resumed using a cached
14626 session or a TLS ticket.
14627
Emeric Brun645ae792014-04-30 14:21:06 +020014628ssl_bc_protocol : string
14629 Returns the name of the used protocol when the outgoing connection was made
14630 over an SSL/TLS transport layer.
14631
Emeric Brunb73a9b02014-04-30 18:49:19 +020014632ssl_bc_unique_id : binary
Emeric Brun645ae792014-04-30 14:21:06 +020014633 When the outgoing connection was made over an SSL/TLS transport layer,
Emeric Brunb73a9b02014-04-30 18:49:19 +020014634 returns the TLS unique ID as defined in RFC5929 section 3. The unique id
14635 can be encoded to base64 using the converter: "ssl_bc_unique_id,base64".
Emeric Brun645ae792014-04-30 14:21:06 +020014636
14637ssl_bc_session_id : binary
14638 Returns the SSL ID of the back connection when the outgoing connection was
14639 made over an SSL/TLS transport layer. It is useful to log if we want to know
14640 if session was reused or not.
14641
Patrick Hemmere0275472018-04-28 19:15:51 -040014642ssl_bc_session_key : binary
14643 Returns the SSL session master key of the back connection when the outgoing
14644 connection was made over an SSL/TLS transport layer. It is useful to decrypt
14645 traffic sent using ephemeral ciphers. This requires OpenSSL >= 1.1.0, or
14646 BoringSSL.
14647
Emeric Brun645ae792014-04-30 14:21:06 +020014648ssl_bc_use_keysize : integer
14649 Returns the symmetric cipher key size used in bits when the outgoing
14650 connection was made over an SSL/TLS transport layer.
14651
Willy Tarreau74ca5042013-06-11 23:12:07 +020014652ssl_c_ca_err : integer
14653 When the incoming connection was made over an SSL/TLS transport layer,
14654 returns the ID of the first error detected during verification of the client
14655 certificate at depth > 0, or 0 if no error was encountered during this
14656 verification process. Please refer to your SSL library's documentation to
14657 find the exhaustive list of error codes.
Willy Tarreauc735a072011-03-29 00:57:02 +020014658
Willy Tarreau74ca5042013-06-11 23:12:07 +020014659ssl_c_ca_err_depth : integer
14660 When the incoming connection was made over an SSL/TLS transport layer,
14661 returns the depth in the CA chain of the first error detected during the
14662 verification of the client certificate. If no error is encountered, 0 is
14663 returned.
Willy Tarreau0ba27502007-12-24 16:55:16 +010014664
Emeric Brun43e79582014-10-29 19:03:26 +010014665ssl_c_der : binary
14666 Returns the DER formatted certificate presented by the client when the
14667 incoming connection was made over an SSL/TLS transport layer. When used for
14668 an ACL, the value(s) to match against can be passed in hexadecimal form.
14669
Willy Tarreau74ca5042013-06-11 23:12:07 +020014670ssl_c_err : integer
14671 When the incoming connection was made over an SSL/TLS transport layer,
14672 returns the ID of the first error detected during verification at depth 0, or
14673 0 if no error was encountered during this verification process. Please refer
14674 to your SSL library's documentation to find the exhaustive list of error
14675 codes.
Willy Tarreau62644772008-07-16 18:36:06 +020014676
Willy Tarreau74ca5042013-06-11 23:12:07 +020014677ssl_c_i_dn([<entry>[,<occ>]]) : string
14678 When the incoming connection was made over an SSL/TLS transport layer,
14679 returns the full distinguished name of the issuer of the certificate
14680 presented by the client when no <entry> is specified, or the value of the
14681 first given entry found from the beginning of the DN. If a positive/negative
14682 occurrence number is specified as the optional second argument, it returns
14683 the value of the nth given entry value from the beginning/end of the DN.
14684 For instance, "ssl_c_i_dn(OU,2)" the second organization unit, and
14685 "ssl_c_i_dn(CN)" retrieves the common name.
Willy Tarreau62644772008-07-16 18:36:06 +020014686
Willy Tarreau74ca5042013-06-11 23:12:07 +020014687ssl_c_key_alg : string
14688 Returns the name of the algorithm used to generate the key of the certificate
14689 presented by the client when the incoming connection was made over an SSL/TLS
14690 transport layer.
Willy Tarreau62644772008-07-16 18:36:06 +020014691
Willy Tarreau74ca5042013-06-11 23:12:07 +020014692ssl_c_notafter : string
14693 Returns the end date presented by the client as a formatted string
14694 YYMMDDhhmmss[Z] when the incoming connection was made over an SSL/TLS
14695 transport layer.
Emeric Brunbede3d02009-06-30 17:54:00 +020014696
Willy Tarreau74ca5042013-06-11 23:12:07 +020014697ssl_c_notbefore : string
14698 Returns the start date presented by the client as a formatted string
14699 YYMMDDhhmmss[Z] when the incoming connection was made over an SSL/TLS
14700 transport layer.
Willy Tarreaub6672b52011-12-12 17:23:41 +010014701
Willy Tarreau74ca5042013-06-11 23:12:07 +020014702ssl_c_s_dn([<entry>[,<occ>]]) : string
14703 When the incoming connection was made over an SSL/TLS transport layer,
14704 returns the full distinguished name of the subject of the certificate
14705 presented by the client when no <entry> is specified, or the value of the
14706 first given entry found from the beginning of the DN. If a positive/negative
14707 occurrence number is specified as the optional second argument, it returns
14708 the value of the nth given entry value from the beginning/end of the DN.
14709 For instance, "ssl_c_s_dn(OU,2)" the second organization unit, and
14710 "ssl_c_s_dn(CN)" retrieves the common name.
Willy Tarreaub6672b52011-12-12 17:23:41 +010014711
Willy Tarreau74ca5042013-06-11 23:12:07 +020014712ssl_c_serial : binary
14713 Returns the serial of the certificate presented by the client when the
14714 incoming connection was made over an SSL/TLS transport layer. When used for
14715 an ACL, the value(s) to match against can be passed in hexadecimal form.
Emeric Brun2525b6b2012-10-18 15:59:43 +020014716
Willy Tarreau74ca5042013-06-11 23:12:07 +020014717ssl_c_sha1 : binary
14718 Returns the SHA-1 fingerprint of the certificate presented by the client when
14719 the incoming connection was made over an SSL/TLS transport layer. This can be
14720 used to stick a client to a server, or to pass this information to a server.
Willy Tarreau2d0caa32014-07-02 19:01:22 +020014721 Note that the output is binary, so if you want to pass that signature to the
14722 server, you need to encode it in hex or base64, such as in the example below:
14723
Jarno Huuskonen676f6222017-03-30 09:19:45 +030014724 Example:
Willy Tarreau2d0caa32014-07-02 19:01:22 +020014725 http-request set-header X-SSL-Client-SHA1 %[ssl_c_sha1,hex]
Emeric Brun2525b6b2012-10-18 15:59:43 +020014726
Willy Tarreau74ca5042013-06-11 23:12:07 +020014727ssl_c_sig_alg : string
14728 Returns the name of the algorithm used to sign the certificate presented by
14729 the client when the incoming connection was made over an SSL/TLS transport
14730 layer.
Emeric Brun87855892012-10-17 17:39:35 +020014731
Willy Tarreau74ca5042013-06-11 23:12:07 +020014732ssl_c_used : boolean
14733 Returns true if current SSL session uses a client certificate even if current
14734 connection uses SSL session resumption. See also "ssl_fc_has_crt".
Emeric Brun7f56e742012-10-19 18:15:40 +020014735
Willy Tarreau74ca5042013-06-11 23:12:07 +020014736ssl_c_verify : integer
14737 Returns the verify result error ID when the incoming connection was made over
14738 an SSL/TLS transport layer, otherwise zero if no error is encountered. Please
14739 refer to your SSL library's documentation for an exhaustive list of error
14740 codes.
Emeric Brunce5ad802012-10-22 14:11:22 +020014741
Willy Tarreau74ca5042013-06-11 23:12:07 +020014742ssl_c_version : integer
14743 Returns the version of the certificate presented by the client when the
14744 incoming connection was made over an SSL/TLS transport layer.
Emeric Brunce5ad802012-10-22 14:11:22 +020014745
Emeric Brun43e79582014-10-29 19:03:26 +010014746ssl_f_der : binary
14747 Returns the DER formatted certificate presented by the frontend when the
14748 incoming connection was made over an SSL/TLS transport layer. When used for
14749 an ACL, the value(s) to match against can be passed in hexadecimal form.
14750
Willy Tarreau74ca5042013-06-11 23:12:07 +020014751ssl_f_i_dn([<entry>[,<occ>]]) : string
14752 When the incoming connection was made over an SSL/TLS transport layer,
14753 returns the full distinguished name of the issuer of the certificate
14754 presented by the frontend when no <entry> is specified, or the value of the
14755 first given entry found from the beginning of the DN. If a positive/negative
Emeric Brun87855892012-10-17 17:39:35 +020014756 occurrence number is specified as the optional second argument, it returns
Willy Tarreau74ca5042013-06-11 23:12:07 +020014757 the value of the nth given entry value from the beginning/end of the DN.
14758 For instance, "ssl_f_i_dn(OU,2)" the second organization unit, and
14759 "ssl_f_i_dn(CN)" retrieves the common name.
Emeric Brun87855892012-10-17 17:39:35 +020014760
Willy Tarreau74ca5042013-06-11 23:12:07 +020014761ssl_f_key_alg : string
14762 Returns the name of the algorithm used to generate the key of the certificate
14763 presented by the frontend when the incoming connection was made over an
14764 SSL/TLS transport layer.
Emeric Brun7f56e742012-10-19 18:15:40 +020014765
Willy Tarreau74ca5042013-06-11 23:12:07 +020014766ssl_f_notafter : string
14767 Returns the end date presented by the frontend as a formatted string
14768 YYMMDDhhmmss[Z] when the incoming connection was made over an SSL/TLS
14769 transport layer.
Emeric Brun2525b6b2012-10-18 15:59:43 +020014770
Willy Tarreau74ca5042013-06-11 23:12:07 +020014771ssl_f_notbefore : string
14772 Returns the start date presented by the frontend as a formatted string
14773 YYMMDDhhmmss[Z] when the incoming connection was made over an SSL/TLS
14774 transport layer.
Emeric Brun87855892012-10-17 17:39:35 +020014775
Willy Tarreau74ca5042013-06-11 23:12:07 +020014776ssl_f_s_dn([<entry>[,<occ>]]) : string
14777 When the incoming connection was made over an SSL/TLS transport layer,
14778 returns the full distinguished name of the subject of the certificate
14779 presented by the frontend when no <entry> is specified, or the value of the
14780 first given entry found from the beginning of the DN. If a positive/negative
14781 occurrence number is specified as the optional second argument, it returns
14782 the value of the nth given entry value from the beginning/end of the DN.
14783 For instance, "ssl_f_s_dn(OU,2)" the second organization unit, and
14784 "ssl_f_s_dn(CN)" retrieves the common name.
Emeric Brunce5ad802012-10-22 14:11:22 +020014785
Willy Tarreau74ca5042013-06-11 23:12:07 +020014786ssl_f_serial : binary
14787 Returns the serial of the certificate presented by the frontend when the
14788 incoming connection was made over an SSL/TLS transport layer. When used for
14789 an ACL, the value(s) to match against can be passed in hexadecimal form.
Emeric Brun87855892012-10-17 17:39:35 +020014790
Emeric Brun55f4fa82014-04-30 17:11:25 +020014791ssl_f_sha1 : binary
14792 Returns the SHA-1 fingerprint of the certificate presented by the frontend
14793 when the incoming connection was made over an SSL/TLS transport layer. This
14794 can be used to know which certificate was chosen using SNI.
14795
Willy Tarreau74ca5042013-06-11 23:12:07 +020014796ssl_f_sig_alg : string
14797 Returns the name of the algorithm used to sign the certificate presented by
14798 the frontend when the incoming connection was made over an SSL/TLS transport
14799 layer.
Emeric Brun7f56e742012-10-19 18:15:40 +020014800
Willy Tarreau74ca5042013-06-11 23:12:07 +020014801ssl_f_version : integer
14802 Returns the version of the certificate presented by the frontend when the
14803 incoming connection was made over an SSL/TLS transport layer.
14804
14805ssl_fc : boolean
Emeric Brun2525b6b2012-10-18 15:59:43 +020014806 Returns true when the front connection was made via an SSL/TLS transport
14807 layer and is locally deciphered. This means it has matched a socket declared
14808 with a "bind" line having the "ssl" option.
14809
Willy Tarreau74ca5042013-06-11 23:12:07 +020014810 Example :
14811 # This passes "X-Proto: https" to servers when client connects over SSL
14812 listen http-https
14813 bind :80
14814 bind :443 ssl crt /etc/haproxy.pem
14815 http-request add-header X-Proto https if { ssl_fc }
14816
14817ssl_fc_alg_keysize : integer
14818 Returns the symmetric cipher key size supported in bits when the incoming
14819 connection was made over an SSL/TLS transport layer.
14820
14821ssl_fc_alpn : string
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030014822 This extracts the Application Layer Protocol Negotiation field from an
Willy Tarreau74ca5042013-06-11 23:12:07 +020014823 incoming connection made via a TLS transport layer and locally deciphered by
14824 haproxy. The result is a string containing the protocol name advertised by
14825 the client. The SSL library must have been built with support for TLS
14826 extensions enabled (check haproxy -vv). Note that the TLS ALPN extension is
14827 not advertised unless the "alpn" keyword on the "bind" line specifies a
14828 protocol list. Also, nothing forces the client to pick a protocol from this
14829 list, any other one may be requested. The TLS ALPN extension is meant to
14830 replace the TLS NPN extension. See also "ssl_fc_npn".
14831
Willy Tarreau74ca5042013-06-11 23:12:07 +020014832ssl_fc_cipher : string
14833 Returns the name of the used cipher when the incoming connection was made
14834 over an SSL/TLS transport layer.
Willy Tarreauab861d32013-04-02 02:30:41 +020014835
Thierry FOURNIER5bf77322017-02-25 12:45:22 +010014836ssl_fc_cipherlist_bin : binary
14837 Returns the binary form of the client hello cipher list. The maximum returned
14838 value length is according with the value of
Emmanuel Hocdetaaee7502017-03-07 18:34:58 +010014839 "tune.ssl.capture-cipherlist-size".
Thierry FOURNIER5bf77322017-02-25 12:45:22 +010014840
14841ssl_fc_cipherlist_hex : string
14842 Returns the binary form of the client hello cipher list encoded as
14843 hexadecimal. The maximum returned value length is according with the value of
Emmanuel Hocdetaaee7502017-03-07 18:34:58 +010014844 "tune.ssl.capture-cipherlist-size".
Thierry FOURNIER5bf77322017-02-25 12:45:22 +010014845
14846ssl_fc_cipherlist_str : string
14847 Returns the decoded text form of the client hello cipher list. The maximum
14848 number of ciphers returned is according with the value of
14849 "tune.ssl.capture-cipherlist-size". Note that this sample-fetch is only
Davor Ocelice9ed2812017-12-25 17:49:28 +010014850 available with OpenSSL >= 1.0.2. If the function is not enabled, this
Emmanuel Hocdetddcde192017-09-01 17:32:08 +020014851 sample-fetch returns the hash like "ssl_fc_cipherlist_xxh".
Thierry FOURNIER5bf77322017-02-25 12:45:22 +010014852
14853ssl_fc_cipherlist_xxh : integer
14854 Returns a xxh64 of the cipher list. This hash can be return only is the value
14855 "tune.ssl.capture-cipherlist-size" is set greater than 0, however the hash
Emmanuel Hocdetaaee7502017-03-07 18:34:58 +010014856 take in account all the data of the cipher list.
Thierry FOURNIER5bf77322017-02-25 12:45:22 +010014857
Willy Tarreau74ca5042013-06-11 23:12:07 +020014858ssl_fc_has_crt : boolean
Emeric Brun2525b6b2012-10-18 15:59:43 +020014859 Returns true if a client certificate is present in an incoming connection over
14860 SSL/TLS transport layer. Useful if 'verify' statement is set to 'optional'.
Emeric Brun9143d372012-12-20 15:44:16 +010014861 Note: on SSL session resumption with Session ID or TLS ticket, client
14862 certificate is not present in the current connection but may be retrieved
14863 from the cache or the ticket. So prefer "ssl_c_used" if you want to check if
14864 current SSL session uses a client certificate.
Emeric Brun2525b6b2012-10-18 15:59:43 +020014865
Olivier Houchardccaa7de2017-10-02 11:51:03 +020014866ssl_fc_has_early : boolean
14867 Returns true if early data were sent, and the handshake didn't happen yet. As
14868 it has security implications, it is useful to be able to refuse those, or
14869 wait until the handshake happened.
14870
Willy Tarreau74ca5042013-06-11 23:12:07 +020014871ssl_fc_has_sni : boolean
14872 This checks for the presence of a Server Name Indication TLS extension (SNI)
Willy Tarreauf7bc57c2012-10-03 00:19:48 +020014873 in an incoming connection was made over an SSL/TLS transport layer. Returns
14874 true when the incoming connection presents a TLS SNI field. This requires
14875 that the SSL library is build with support for TLS extensions enabled (check
14876 haproxy -vv).
Willy Tarreau7875d092012-09-10 08:20:03 +020014877
Nenad Merdanovic1516fe32016-05-17 03:31:21 +020014878ssl_fc_is_resumed : boolean
Nenad Merdanovic26ea8222015-05-18 02:28:57 +020014879 Returns true if the SSL/TLS session has been resumed through the use of
Jérôme Magnin4a326cb2018-01-15 14:01:17 +010014880 SSL session cache or TLS tickets on an incoming connection over an SSL/TLS
14881 transport layer.
Nenad Merdanovic26ea8222015-05-18 02:28:57 +020014882
Willy Tarreau74ca5042013-06-11 23:12:07 +020014883ssl_fc_npn : string
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030014884 This extracts the Next Protocol Negotiation field from an incoming connection
Willy Tarreau74ca5042013-06-11 23:12:07 +020014885 made via a TLS transport layer and locally deciphered by haproxy. The result
14886 is a string containing the protocol name advertised by the client. The SSL
14887 library must have been built with support for TLS extensions enabled (check
14888 haproxy -vv). Note that the TLS NPN extension is not advertised unless the
14889 "npn" keyword on the "bind" line specifies a protocol list. Also, nothing
14890 forces the client to pick a protocol from this list, any other one may be
14891 requested. Please note that the TLS NPN extension was replaced with ALPN.
Willy Tarreaua33c6542012-10-15 13:19:06 +020014892
Willy Tarreau74ca5042013-06-11 23:12:07 +020014893ssl_fc_protocol : string
14894 Returns the name of the used protocol when the incoming connection was made
14895 over an SSL/TLS transport layer.
Willy Tarreau7875d092012-09-10 08:20:03 +020014896
Emeric Brunb73a9b02014-04-30 18:49:19 +020014897ssl_fc_unique_id : binary
David Sc1ad52e2014-04-08 18:48:47 -040014898 When the incoming connection was made over an SSL/TLS transport layer,
Emeric Brunb73a9b02014-04-30 18:49:19 +020014899 returns the TLS unique ID as defined in RFC5929 section 3. The unique id
14900 can be encoded to base64 using the converter: "ssl_bc_unique_id,base64".
David Sc1ad52e2014-04-08 18:48:47 -040014901
Willy Tarreau74ca5042013-06-11 23:12:07 +020014902ssl_fc_session_id : binary
14903 Returns the SSL ID of the front connection when the incoming connection was
14904 made over an SSL/TLS transport layer. It is useful to stick a given client to
14905 a server. It is important to note that some browsers refresh their session ID
14906 every few minutes.
Willy Tarreau7875d092012-09-10 08:20:03 +020014907
Patrick Hemmere0275472018-04-28 19:15:51 -040014908ssl_fc_session_key : binary
14909 Returns the SSL session master key of the front connection when the incoming
14910 connection was made over an SSL/TLS transport layer. It is useful to decrypt
14911 traffic sent using ephemeral ciphers. This requires OpenSSL >= 1.1.0, or
14912 BoringSSL.
14913
14914
Willy Tarreau74ca5042013-06-11 23:12:07 +020014915ssl_fc_sni : string
14916 This extracts the Server Name Indication TLS extension (SNI) field from an
14917 incoming connection made via an SSL/TLS transport layer and locally
14918 deciphered by haproxy. The result (when present) typically is a string
14919 matching the HTTPS host name (253 chars or less). The SSL library must have
14920 been built with support for TLS extensions enabled (check haproxy -vv).
14921
14922 This fetch is different from "req_ssl_sni" above in that it applies to the
14923 connection being deciphered by haproxy and not to SSL contents being blindly
14924 forwarded. See also "ssl_fc_sni_end" and "ssl_fc_sni_reg" below. This
Cyril Bonté9c1eb1e2012-10-09 22:45:34 +020014925 requires that the SSL library is build with support for TLS extensions
14926 enabled (check haproxy -vv).
Willy Tarreau62644772008-07-16 18:36:06 +020014927
Willy Tarreau74ca5042013-06-11 23:12:07 +020014928 ACL derivatives :
Willy Tarreau74ca5042013-06-11 23:12:07 +020014929 ssl_fc_sni_end : suffix match
14930 ssl_fc_sni_reg : regex match
Emeric Brun589fcad2012-10-16 14:13:26 +020014931
Willy Tarreau74ca5042013-06-11 23:12:07 +020014932ssl_fc_use_keysize : integer
14933 Returns the symmetric cipher key size used in bits when the incoming
14934 connection was made over an SSL/TLS transport layer.
Willy Tarreaub6fb4202008-07-20 11:18:28 +020014935
Willy Tarreaub6fb4202008-07-20 11:18:28 +020014936
Thierry FOURNIER060762e2014-04-23 13:29:15 +0200149377.3.5. Fetching samples from buffer contents (Layer 6)
Willy Tarreau74ca5042013-06-11 23:12:07 +020014938------------------------------------------------------
Willy Tarreaub6fb4202008-07-20 11:18:28 +020014939
Willy Tarreau74ca5042013-06-11 23:12:07 +020014940Fetching samples from buffer contents is a bit different from the previous
14941sample fetches above because the sampled data are ephemeral. These data can
14942only be used when they're available and will be lost when they're forwarded.
14943For this reason, samples fetched from buffer contents during a request cannot
14944be used in a response for example. Even while the data are being fetched, they
14945can change. Sometimes it is necessary to set some delays or combine multiple
14946sample fetch methods to ensure that the expected data are complete and usable,
14947for example through TCP request content inspection. Please see the "tcp-request
14948content" keyword for more detailed information on the subject.
Willy Tarreau62644772008-07-16 18:36:06 +020014949
Willy Tarreau74ca5042013-06-11 23:12:07 +020014950payload(<offset>,<length>) : binary (deprecated)
Davor Ocelice9ed2812017-12-25 17:49:28 +010014951 This is an alias for "req.payload" when used in the context of a request (e.g.
Willy Tarreau74ca5042013-06-11 23:12:07 +020014952 "stick on", "stick match"), and for "res.payload" when used in the context of
14953 a response such as in "stick store response".
Willy Tarreau0ba27502007-12-24 16:55:16 +010014954
Willy Tarreau74ca5042013-06-11 23:12:07 +020014955payload_lv(<offset1>,<length>[,<offset2>]) : binary (deprecated)
14956 This is an alias for "req.payload_lv" when used in the context of a request
Davor Ocelice9ed2812017-12-25 17:49:28 +010014957 (e.g. "stick on", "stick match"), and for "res.payload_lv" when used in the
Willy Tarreau74ca5042013-06-11 23:12:07 +020014958 context of a response such as in "stick store response".
Willy Tarreau0ba27502007-12-24 16:55:16 +010014959
Thierry FOURNIERd7d88812017-04-19 15:15:14 +020014960req.hdrs : string
14961 Returns the current request headers as string including the last empty line
14962 separating headers from the request body. The last empty line can be used to
14963 detect a truncated header block. This sample fetch is useful for some SPOE
14964 headers analyzers and for advanced logging.
14965
Thierry FOURNIER5617dce2017-04-09 05:38:19 +020014966req.hdrs_bin : binary
14967 Returns the current request headers contained in preparsed binary form. This
14968 is useful for offloading some processing with SPOE. Each string is described
14969 by a length followed by the number of bytes indicated in the length. The
14970 length is represented using the variable integer encoding detailed in the
14971 SPOE documentation. The end of the list is marked by a couple of empty header
14972 names and values (length of 0 for both).
14973
14974 *(<str:header-name><str:header-value>)<empty string><empty string>
14975
14976 int: refer to the SPOE documentation for the encoding
14977 str: <int:length><bytes>
14978
Willy Tarreau74ca5042013-06-11 23:12:07 +020014979req.len : integer
14980req_len : integer (deprecated)
14981 Returns an integer value corresponding to the number of bytes present in the
14982 request buffer. This is mostly used in ACL. It is important to understand
14983 that this test does not return false as long as the buffer is changing. This
14984 means that a check with equality to zero will almost always immediately match
14985 at the beginning of the session, while a test for more data will wait for
14986 that data to come in and return false only when haproxy is certain that no
14987 more data will come in. This test was designed to be used with TCP request
14988 content inspection.
Willy Tarreaua7ad50c2012-04-29 15:39:40 +020014989
Willy Tarreau74ca5042013-06-11 23:12:07 +020014990req.payload(<offset>,<length>) : binary
14991 This extracts a binary block of <length> bytes and starting at byte <offset>
Willy Tarreau00f00842013-08-02 11:07:32 +020014992 in the request buffer. As a special case, if the <length> argument is zero,
14993 the the whole buffer from <offset> to the end is extracted. This can be used
14994 with ACLs in order to check for the presence of some content in a buffer at
14995 any location.
Willy Tarreaua7ad50c2012-04-29 15:39:40 +020014996
Willy Tarreau74ca5042013-06-11 23:12:07 +020014997 ACL alternatives :
14998 payload(<offset>,<length>) : hex binary match
Willy Tarreaua7ad50c2012-04-29 15:39:40 +020014999
Willy Tarreau74ca5042013-06-11 23:12:07 +020015000req.payload_lv(<offset1>,<length>[,<offset2>]) : binary
15001 This extracts a binary block whose size is specified at <offset1> for <length>
15002 bytes, and which starts at <offset2> if specified or just after the length in
15003 the request buffer. The <offset2> parameter also supports relative offsets if
15004 prepended with a '+' or '-' sign.
Willy Tarreaua7ad50c2012-04-29 15:39:40 +020015005
Willy Tarreau74ca5042013-06-11 23:12:07 +020015006 ACL alternatives :
15007 payload_lv(<offset1>,<length>[,<offset2>]) : hex binary match
Willy Tarreaua7ad50c2012-04-29 15:39:40 +020015008
Willy Tarreau74ca5042013-06-11 23:12:07 +020015009 Example : please consult the example from the "stick store-response" keyword.
Willy Tarreaua7ad50c2012-04-29 15:39:40 +020015010
Willy Tarreau74ca5042013-06-11 23:12:07 +020015011req.proto_http : boolean
15012req_proto_http : boolean (deprecated)
15013 Returns true when data in the request buffer look like HTTP and correctly
15014 parses as such. It is the same parser as the common HTTP request parser which
15015 is used so there should be no surprises. The test does not match until the
15016 request is complete, failed or timed out. This test may be used to report the
15017 protocol in TCP logs, but the biggest use is to block TCP request analysis
15018 until a complete HTTP request is present in the buffer, for example to track
15019 a header.
Willy Tarreaua7ad50c2012-04-29 15:39:40 +020015020
Willy Tarreau74ca5042013-06-11 23:12:07 +020015021 Example:
15022 # track request counts per "base" (concatenation of Host+URL)
15023 tcp-request inspect-delay 10s
15024 tcp-request content reject if !HTTP
Willy Tarreaube4a3ef2013-06-17 15:04:07 +020015025 tcp-request content track-sc0 base table req-rate
Willy Tarreaua7ad50c2012-04-29 15:39:40 +020015026
Willy Tarreau74ca5042013-06-11 23:12:07 +020015027req.rdp_cookie([<name>]) : string
15028rdp_cookie([<name>]) : string (deprecated)
15029 When the request buffer looks like the RDP protocol, extracts the RDP cookie
15030 <name>, or any cookie if unspecified. The parser only checks for the first
15031 cookie, as illustrated in the RDP protocol specification. The cookie name is
15032 case insensitive. Generally the "MSTS" cookie name will be used, as it can
15033 contain the user name of the client connecting to the server if properly
15034 configured on the client. The "MSTSHASH" cookie is often used as well for
15035 session stickiness to servers.
Willy Tarreau04aa6a92012-04-06 18:57:55 +020015036
Willy Tarreau74ca5042013-06-11 23:12:07 +020015037 This differs from "balance rdp-cookie" in that any balancing algorithm may be
15038 used and thus the distribution of clients to backend servers is not linked to
15039 a hash of the RDP cookie. It is envisaged that using a balancing algorithm
15040 such as "balance roundrobin" or "balance leastconn" will lead to a more even
15041 distribution of clients to backend servers than the hash used by "balance
15042 rdp-cookie".
Willy Tarreau04aa6a92012-04-06 18:57:55 +020015043
Willy Tarreau74ca5042013-06-11 23:12:07 +020015044 ACL derivatives :
15045 req_rdp_cookie([<name>]) : exact string match
Willy Tarreau04aa6a92012-04-06 18:57:55 +020015046
Willy Tarreau74ca5042013-06-11 23:12:07 +020015047 Example :
15048 listen tse-farm
15049 bind 0.0.0.0:3389
15050 # wait up to 5s for an RDP cookie in the request
15051 tcp-request inspect-delay 5s
15052 tcp-request content accept if RDP_COOKIE
15053 # apply RDP cookie persistence
15054 persist rdp-cookie
15055 # Persist based on the mstshash cookie
15056 # This is only useful makes sense if
15057 # balance rdp-cookie is not used
15058 stick-table type string size 204800
15059 stick on req.rdp_cookie(mstshash)
15060 server srv1 1.1.1.1:3389
15061 server srv1 1.1.1.2:3389
Willy Tarreau04aa6a92012-04-06 18:57:55 +020015062
Willy Tarreau74ca5042013-06-11 23:12:07 +020015063 See also : "balance rdp-cookie", "persist rdp-cookie", "tcp-request" and the
15064 "req_rdp_cookie" ACL.
Willy Tarreau04aa6a92012-04-06 18:57:55 +020015065
Willy Tarreau74ca5042013-06-11 23:12:07 +020015066req.rdp_cookie_cnt([name]) : integer
15067rdp_cookie_cnt([name]) : integer (deprecated)
15068 Tries to parse the request buffer as RDP protocol, then returns an integer
15069 corresponding to the number of RDP cookies found. If an optional cookie name
15070 is passed, only cookies matching this name are considered. This is mostly
15071 used in ACL.
Willy Tarreau04aa6a92012-04-06 18:57:55 +020015072
Willy Tarreau74ca5042013-06-11 23:12:07 +020015073 ACL derivatives :
15074 req_rdp_cookie_cnt([<name>]) : integer match
Willy Tarreau04aa6a92012-04-06 18:57:55 +020015075
Nenad Merdanovic5fc7d7e2015-07-07 22:00:17 +020015076req.ssl_ec_ext : boolean
15077 Returns a boolean identifying if client sent the Supported Elliptic Curves
15078 Extension as defined in RFC4492, section 5.1. within the SSL ClientHello
Cyril Bonté307ee1e2015-09-28 23:16:06 +020015079 message. This can be used to present ECC compatible clients with EC
15080 certificate and to use RSA for all others, on the same IP address. Note that
15081 this only applies to raw contents found in the request buffer and not to
15082 contents deciphered via an SSL data layer, so this will not work with "bind"
15083 lines having the "ssl" option.
Nenad Merdanovic5fc7d7e2015-07-07 22:00:17 +020015084
Willy Tarreau74ca5042013-06-11 23:12:07 +020015085req.ssl_hello_type : integer
15086req_ssl_hello_type : integer (deprecated)
15087 Returns an integer value containing the type of the SSL hello message found
15088 in the request buffer if the buffer contains data that parse as a complete
15089 SSL (v3 or superior) client hello message. Note that this only applies to raw
15090 contents found in the request buffer and not to contents deciphered via an
15091 SSL data layer, so this will not work with "bind" lines having the "ssl"
15092 option. This is mostly used in ACL to detect presence of an SSL hello message
15093 that is supposed to contain an SSL session ID usable for stickiness.
Willy Tarreau04aa6a92012-04-06 18:57:55 +020015094
Willy Tarreau74ca5042013-06-11 23:12:07 +020015095req.ssl_sni : string
15096req_ssl_sni : string (deprecated)
15097 Returns a string containing the value of the Server Name TLS extension sent
15098 by a client in a TLS stream passing through the request buffer if the buffer
15099 contains data that parse as a complete SSL (v3 or superior) client hello
15100 message. Note that this only applies to raw contents found in the request
15101 buffer and not to contents deciphered via an SSL data layer, so this will not
15102 work with "bind" lines having the "ssl" option. SNI normally contains the
15103 name of the host the client tries to connect to (for recent browsers). SNI is
15104 useful for allowing or denying access to certain hosts when SSL/TLS is used
15105 by the client. This test was designed to be used with TCP request content
15106 inspection. If content switching is needed, it is recommended to first wait
15107 for a complete client hello (type 1), like in the example below. See also
15108 "ssl_fc_sni".
Willy Tarreau04aa6a92012-04-06 18:57:55 +020015109
Willy Tarreau74ca5042013-06-11 23:12:07 +020015110 ACL derivatives :
15111 req_ssl_sni : exact string match
Willy Tarreau04aa6a92012-04-06 18:57:55 +020015112
Willy Tarreau74ca5042013-06-11 23:12:07 +020015113 Examples :
15114 # Wait for a client hello for at most 5 seconds
15115 tcp-request inspect-delay 5s
15116 tcp-request content accept if { req_ssl_hello_type 1 }
15117 use_backend bk_allow if { req_ssl_sni -f allowed_sites }
15118 default_backend bk_sorry_page
Willy Tarreau04aa6a92012-04-06 18:57:55 +020015119
Pradeep Jindalbb2acf52015-09-29 10:12:57 +053015120req.ssl_st_ext : integer
15121 Returns 0 if the client didn't send a SessionTicket TLS Extension (RFC5077)
15122 Returns 1 if the client sent SessionTicket TLS Extension
15123 Returns 2 if the client also sent non-zero length TLS SessionTicket
15124 Note that this only applies to raw contents found in the request buffer and
15125 not to contents deciphered via an SSL data layer, so this will not work with
15126 "bind" lines having the "ssl" option. This can for example be used to detect
15127 whether the client sent a SessionTicket or not and stick it accordingly, if
15128 no SessionTicket then stick on SessionID or don't stick as there's no server
15129 side state is there when SessionTickets are in use.
15130
Willy Tarreau74ca5042013-06-11 23:12:07 +020015131req.ssl_ver : integer
15132req_ssl_ver : integer (deprecated)
15133 Returns an integer value containing the version of the SSL/TLS protocol of a
15134 stream present in the request buffer. Both SSLv2 hello messages and SSLv3
15135 messages are supported. TLSv1 is announced as SSL version 3.1. The value is
15136 composed of the major version multiplied by 65536, added to the minor
15137 version. Note that this only applies to raw contents found in the request
15138 buffer and not to contents deciphered via an SSL data layer, so this will not
15139 work with "bind" lines having the "ssl" option. The ACL version of the test
Davor Ocelice9ed2812017-12-25 17:49:28 +010015140 matches against a decimal notation in the form MAJOR.MINOR (e.g. 3.1). This
Willy Tarreau74ca5042013-06-11 23:12:07 +020015141 fetch is mostly used in ACL.
Willy Tarreaud63335a2010-02-26 12:56:52 +010015142
Willy Tarreau74ca5042013-06-11 23:12:07 +020015143 ACL derivatives :
15144 req_ssl_ver : decimal match
Willy Tarreaud63335a2010-02-26 12:56:52 +010015145
Willy Tarreau47e8eba2013-09-11 23:28:46 +020015146res.len : integer
15147 Returns an integer value corresponding to the number of bytes present in the
15148 response buffer. This is mostly used in ACL. It is important to understand
15149 that this test does not return false as long as the buffer is changing. This
15150 means that a check with equality to zero will almost always immediately match
15151 at the beginning of the session, while a test for more data will wait for
15152 that data to come in and return false only when haproxy is certain that no
15153 more data will come in. This test was designed to be used with TCP response
15154 content inspection.
15155
Willy Tarreau74ca5042013-06-11 23:12:07 +020015156res.payload(<offset>,<length>) : binary
15157 This extracts a binary block of <length> bytes and starting at byte <offset>
Willy Tarreau00f00842013-08-02 11:07:32 +020015158 in the response buffer. As a special case, if the <length> argument is zero,
15159 the the whole buffer from <offset> to the end is extracted. This can be used
15160 with ACLs in order to check for the presence of some content in a buffer at
15161 any location.
Willy Tarreaud63335a2010-02-26 12:56:52 +010015162
Willy Tarreau74ca5042013-06-11 23:12:07 +020015163res.payload_lv(<offset1>,<length>[,<offset2>]) : binary
15164 This extracts a binary block whose size is specified at <offset1> for <length>
15165 bytes, and which starts at <offset2> if specified or just after the length in
15166 the response buffer. The <offset2> parameter also supports relative offsets
15167 if prepended with a '+' or '-' sign.
Willy Tarreaud63335a2010-02-26 12:56:52 +010015168
Willy Tarreau74ca5042013-06-11 23:12:07 +020015169 Example : please consult the example from the "stick store-response" keyword.
Willy Tarreaud63335a2010-02-26 12:56:52 +010015170
Willy Tarreau971f7b62015-09-29 14:06:59 +020015171res.ssl_hello_type : integer
15172rep_ssl_hello_type : integer (deprecated)
15173 Returns an integer value containing the type of the SSL hello message found
15174 in the response buffer if the buffer contains data that parses as a complete
15175 SSL (v3 or superior) hello message. Note that this only applies to raw
15176 contents found in the response buffer and not to contents deciphered via an
15177 SSL data layer, so this will not work with "server" lines having the "ssl"
15178 option. This is mostly used in ACL to detect presence of an SSL hello message
15179 that is supposed to contain an SSL session ID usable for stickiness.
15180
Willy Tarreau74ca5042013-06-11 23:12:07 +020015181wait_end : boolean
15182 This fetch either returns true when the inspection period is over, or does
15183 not fetch. It is only used in ACLs, in conjunction with content analysis to
Davor Ocelice9ed2812017-12-25 17:49:28 +010015184 avoid returning a wrong verdict early. It may also be used to delay some
Willy Tarreau74ca5042013-06-11 23:12:07 +020015185 actions, such as a delayed reject for some special addresses. Since it either
15186 stops the rules evaluation or immediately returns true, it is recommended to
Davor Ocelice9ed2812017-12-25 17:49:28 +010015187 use this acl as the last one in a rule. Please note that the default ACL
Willy Tarreau74ca5042013-06-11 23:12:07 +020015188 "WAIT_END" is always usable without prior declaration. This test was designed
15189 to be used with TCP request content inspection.
Willy Tarreaud63335a2010-02-26 12:56:52 +010015190
Willy Tarreau74ca5042013-06-11 23:12:07 +020015191 Examples :
15192 # delay every incoming request by 2 seconds
15193 tcp-request inspect-delay 2s
15194 tcp-request content accept if WAIT_END
Willy Tarreaud63335a2010-02-26 12:56:52 +010015195
Willy Tarreau74ca5042013-06-11 23:12:07 +020015196 # don't immediately tell bad guys they are rejected
15197 tcp-request inspect-delay 10s
15198 acl goodguys src 10.0.0.0/24
15199 acl badguys src 10.0.1.0/24
15200 tcp-request content accept if goodguys
15201 tcp-request content reject if badguys WAIT_END
15202 tcp-request content reject
15203
15204
Thierry FOURNIER060762e2014-04-23 13:29:15 +0200152057.3.6. Fetching HTTP samples (Layer 7)
Willy Tarreau74ca5042013-06-11 23:12:07 +020015206--------------------------------------
15207
15208It is possible to fetch samples from HTTP contents, requests and responses.
15209This application layer is also called layer 7. It is only possible to fetch the
15210data in this section when a full HTTP request or response has been parsed from
15211its respective request or response buffer. This is always the case with all
15212HTTP specific rules and for sections running with "mode http". When using TCP
15213content inspection, it may be necessary to support an inspection delay in order
15214to let the request or response come in first. These fetches may require a bit
15215more CPU resources than the layer 4 ones, but not much since the request and
15216response are indexed.
15217
15218base : string
15219 This returns the concatenation of the first Host header and the path part of
15220 the request, which starts at the first slash and ends before the question
15221 mark. It can be useful in virtual hosted environments to detect URL abuses as
15222 well as to improve shared caches efficiency. Using this with a limited size
15223 stick table also allows one to collect statistics about most commonly
15224 requested objects by host/path. With ACLs it can allow simple content
15225 switching rules involving the host and the path at the same time, such as
15226 "www.example.com/favicon.ico". See also "path" and "uri".
15227
15228 ACL derivatives :
15229 base : exact string match
15230 base_beg : prefix match
15231 base_dir : subdir match
15232 base_dom : domain match
15233 base_end : suffix match
15234 base_len : length match
15235 base_reg : regex match
15236 base_sub : substring match
15237
15238base32 : integer
15239 This returns a 32-bit hash of the value returned by the "base" fetch method
15240 above. This is useful to track per-URL activity on high traffic sites without
15241 having to store all URLs. Instead a shorter hash is stored, saving a lot of
Willy Tarreau23ec4ca2014-07-15 20:15:37 +020015242 memory. The output type is an unsigned integer. The hash function used is
15243 SDBM with full avalanche on the output. Technically, base32 is exactly equal
15244 to "base,sdbm(1)".
Willy Tarreau74ca5042013-06-11 23:12:07 +020015245
15246base32+src : binary
15247 This returns the concatenation of the base32 fetch above and the src fetch
15248 below. The resulting type is of type binary, with a size of 8 or 20 bytes
15249 depending on the source address family. This can be used to track per-IP,
15250 per-URL counters.
15251
William Lallemand65ad6e12014-01-31 15:08:02 +010015252capture.req.hdr(<idx>) : string
15253 This extracts the content of the header captured by the "capture request
15254 header", idx is the position of the capture keyword in the configuration.
15255 The first entry is an index of 0. See also: "capture request header".
15256
15257capture.req.method : string
15258 This extracts the METHOD of an HTTP request. It can be used in both request
15259 and response. Unlike "method", it can be used in both request and response
15260 because it's allocated.
15261
15262capture.req.uri : string
15263 This extracts the request's URI, which starts at the first slash and ends
15264 before the first space in the request (without the host part). Unlike "path"
15265 and "url", it can be used in both request and response because it's
15266 allocated.
15267
Willy Tarreau3c1b5ec2014-04-24 23:41:57 +020015268capture.req.ver : string
15269 This extracts the request's HTTP version and returns either "HTTP/1.0" or
15270 "HTTP/1.1". Unlike "req.ver", it can be used in both request, response, and
15271 logs because it relies on a persistent flag.
15272
William Lallemand65ad6e12014-01-31 15:08:02 +010015273capture.res.hdr(<idx>) : string
15274 This extracts the content of the header captured by the "capture response
15275 header", idx is the position of the capture keyword in the configuration.
15276 The first entry is an index of 0.
15277 See also: "capture response header"
15278
Willy Tarreau3c1b5ec2014-04-24 23:41:57 +020015279capture.res.ver : string
15280 This extracts the response's HTTP version and returns either "HTTP/1.0" or
15281 "HTTP/1.1". Unlike "res.ver", it can be used in logs because it relies on a
15282 persistent flag.
15283
Willy Tarreaua5910cc2015-05-02 00:46:08 +020015284req.body : binary
15285 This returns the HTTP request's available body as a block of data. It
15286 requires that the request body has been buffered made available using
15287 "option http-buffer-request". In case of chunked-encoded body, currently only
15288 the first chunk is analyzed.
15289
Thierry FOURNIER9826c772015-05-20 15:50:54 +020015290req.body_param([<name>) : string
15291 This fetch assumes that the body of the POST request is url-encoded. The user
15292 can check if the "content-type" contains the value
15293 "application/x-www-form-urlencoded". This extracts the first occurrence of the
15294 parameter <name> in the body, which ends before '&'. The parameter name is
15295 case-sensitive. If no name is given, any parameter will match, and the first
15296 one will be returned. The result is a string corresponding to the value of the
15297 parameter <name> as presented in the request body (no URL decoding is
15298 performed). Note that the ACL version of this fetch iterates over multiple
15299 parameters and will iteratively report all parameters values if no name is
15300 given.
15301
Willy Tarreaua5910cc2015-05-02 00:46:08 +020015302req.body_len : integer
15303 This returns the length of the HTTP request's available body in bytes. It may
15304 be lower than the advertised length if the body is larger than the buffer. It
15305 requires that the request body has been buffered made available using
15306 "option http-buffer-request".
15307
15308req.body_size : integer
15309 This returns the advertised length of the HTTP request's body in bytes. It
15310 will represent the advertised Content-Length header, or the size of the first
15311 chunk in case of chunked encoding. In order to parse the chunks, it requires
15312 that the request body has been buffered made available using
15313 "option http-buffer-request".
15314
Willy Tarreau74ca5042013-06-11 23:12:07 +020015315req.cook([<name>]) : string
15316cook([<name>]) : string (deprecated)
15317 This extracts the last occurrence of the cookie name <name> on a "Cookie"
15318 header line from the request, and returns its value as string. If no name is
15319 specified, the first cookie value is returned. When used with ACLs, all
15320 matching cookies are evaluated. Spaces around the name and the value are
15321 ignored as requested by the Cookie header specification (RFC6265). The cookie
15322 name is case-sensitive. Empty cookies are valid, so an empty cookie may very
15323 well return an empty value if it is present. Use the "found" match to detect
15324 presence. Use the res.cook() variant for response cookies sent by the server.
15325
15326 ACL derivatives :
15327 cook([<name>]) : exact string match
15328 cook_beg([<name>]) : prefix match
15329 cook_dir([<name>]) : subdir match
15330 cook_dom([<name>]) : domain match
15331 cook_end([<name>]) : suffix match
15332 cook_len([<name>]) : length match
15333 cook_reg([<name>]) : regex match
15334 cook_sub([<name>]) : substring match
Willy Tarreaud63335a2010-02-26 12:56:52 +010015335
Willy Tarreau74ca5042013-06-11 23:12:07 +020015336req.cook_cnt([<name>]) : integer
15337cook_cnt([<name>]) : integer (deprecated)
15338 Returns an integer value representing the number of occurrences of the cookie
15339 <name> in the request, or all cookies if <name> is not specified.
Willy Tarreaud63335a2010-02-26 12:56:52 +010015340
Willy Tarreau74ca5042013-06-11 23:12:07 +020015341req.cook_val([<name>]) : integer
15342cook_val([<name>]) : integer (deprecated)
15343 This extracts the last occurrence of the cookie name <name> on a "Cookie"
15344 header line from the request, and converts its value to an integer which is
15345 returned. If no name is specified, the first cookie value is returned. When
15346 used in ACLs, all matching names are iterated over until a value matches.
Willy Tarreau0e698542011-09-16 08:32:32 +020015347
Willy Tarreau74ca5042013-06-11 23:12:07 +020015348cookie([<name>]) : string (deprecated)
15349 This extracts the last occurrence of the cookie name <name> on a "Cookie"
15350 header line from the request, or a "Set-Cookie" header from the response, and
15351 returns its value as a string. A typical use is to get multiple clients
15352 sharing a same profile use the same server. This can be similar to what
Willy Tarreau294d0f02015-08-10 19:40:12 +020015353 "appsession" did with the "request-learn" statement, but with support for
Willy Tarreau74ca5042013-06-11 23:12:07 +020015354 multi-peer synchronization and state keeping across restarts. If no name is
15355 specified, the first cookie value is returned. This fetch should not be used
15356 anymore and should be replaced by req.cook() or res.cook() instead as it
15357 ambiguously uses the direction based on the context where it is used.
Willy Tarreaud63335a2010-02-26 12:56:52 +010015358
Willy Tarreau74ca5042013-06-11 23:12:07 +020015359hdr([<name>[,<occ>]]) : string
15360 This is equivalent to req.hdr() when used on requests, and to res.hdr() when
15361 used on responses. Please refer to these respective fetches for more details.
15362 In case of doubt about the fetch direction, please use the explicit ones.
15363 Note that contrary to the hdr() sample fetch method, the hdr_* ACL keywords
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030015364 unambiguously apply to the request headers.
Willy Tarreaud63335a2010-02-26 12:56:52 +010015365
Willy Tarreau74ca5042013-06-11 23:12:07 +020015366req.fhdr(<name>[,<occ>]) : string
15367 This extracts the last occurrence of header <name> in an HTTP request. When
15368 used from an ACL, all occurrences are iterated over until a match is found.
15369 Optionally, a specific occurrence might be specified as a position number.
15370 Positive values indicate a position from the first occurrence, with 1 being
15371 the first one. Negative values indicate positions relative to the last one,
15372 with -1 being the last one. It differs from req.hdr() in that any commas
15373 present in the value are returned and are not used as delimiters. This is
15374 sometimes useful with headers such as User-Agent.
Willy Tarreaud63335a2010-02-26 12:56:52 +010015375
Willy Tarreau74ca5042013-06-11 23:12:07 +020015376req.fhdr_cnt([<name>]) : integer
15377 Returns an integer value representing the number of occurrences of request
15378 header field name <name>, or the total number of header fields if <name> is
15379 not specified. Contrary to its req.hdr_cnt() cousin, this function returns
15380 the number of full line headers and does not stop on commas.
Willy Tarreaud63335a2010-02-26 12:56:52 +010015381
Willy Tarreau74ca5042013-06-11 23:12:07 +020015382req.hdr([<name>[,<occ>]]) : string
15383 This extracts the last occurrence of header <name> in an HTTP request. When
15384 used from an ACL, all occurrences are iterated over until a match is found.
15385 Optionally, a specific occurrence might be specified as a position number.
15386 Positive values indicate a position from the first occurrence, with 1 being
15387 the first one. Negative values indicate positions relative to the last one,
15388 with -1 being the last one. A typical use is with the X-Forwarded-For header
15389 once converted to IP, associated with an IP stick-table. The function
15390 considers any comma as a delimiter for distinct values. If full-line headers
Lukas Tribus23953682017-04-28 13:24:30 +000015391 are desired instead, use req.fhdr(). Please carefully check RFC7231 to know
Willy Tarreau74ca5042013-06-11 23:12:07 +020015392 how certain headers are supposed to be parsed. Also, some of them are case
Davor Ocelice9ed2812017-12-25 17:49:28 +010015393 insensitive (e.g. Connection).
Willy Tarreaud63335a2010-02-26 12:56:52 +010015394
Willy Tarreau74ca5042013-06-11 23:12:07 +020015395 ACL derivatives :
15396 hdr([<name>[,<occ>]]) : exact string match
15397 hdr_beg([<name>[,<occ>]]) : prefix match
15398 hdr_dir([<name>[,<occ>]]) : subdir match
15399 hdr_dom([<name>[,<occ>]]) : domain match
15400 hdr_end([<name>[,<occ>]]) : suffix match
15401 hdr_len([<name>[,<occ>]]) : length match
15402 hdr_reg([<name>[,<occ>]]) : regex match
15403 hdr_sub([<name>[,<occ>]]) : substring match
15404
15405req.hdr_cnt([<name>]) : integer
15406hdr_cnt([<header>]) : integer (deprecated)
15407 Returns an integer value representing the number of occurrences of request
15408 header field name <name>, or the total number of header field values if
15409 <name> is not specified. It is important to remember that one header line may
15410 count as several headers if it has several values. The function considers any
15411 comma as a delimiter for distinct values. If full-line headers are desired
15412 instead, req.fhdr_cnt() should be used instead. With ACLs, it can be used to
15413 detect presence, absence or abuse of a specific header, as well as to block
15414 request smuggling attacks by rejecting requests which contain more than one
15415 of certain headers. See "req.hdr" for more information on header matching.
15416
15417req.hdr_ip([<name>[,<occ>]]) : ip
15418hdr_ip([<name>[,<occ>]]) : ip (deprecated)
15419 This extracts the last occurrence of header <name> in an HTTP request,
15420 converts it to an IPv4 or IPv6 address and returns this address. When used
15421 with ACLs, all occurrences are checked, and if <name> is omitted, every value
15422 of every header is checked. Optionally, a specific occurrence might be
15423 specified as a position number. Positive values indicate a position from the
Davor Ocelice9ed2812017-12-25 17:49:28 +010015424 first occurrence, with 1 being the first one. Negative values indicate
Willy Tarreau74ca5042013-06-11 23:12:07 +020015425 positions relative to the last one, with -1 being the last one. A typical use
15426 is with the X-Forwarded-For and X-Client-IP headers.
15427
15428req.hdr_val([<name>[,<occ>]]) : integer
15429hdr_val([<name>[,<occ>]]) : integer (deprecated)
15430 This extracts the last occurrence of header <name> in an HTTP request, and
15431 converts it to an integer value. When used with ACLs, all occurrences are
15432 checked, and if <name> is omitted, every value of every header is checked.
15433 Optionally, a specific occurrence might be specified as a position number.
15434 Positive values indicate a position from the first occurrence, with 1 being
15435 the first one. Negative values indicate positions relative to the last one,
15436 with -1 being the last one. A typical use is with the X-Forwarded-For header.
15437
15438http_auth(<userlist>) : boolean
15439 Returns a boolean indicating whether the authentication data received from
15440 the client match a username & password stored in the specified userlist. This
15441 fetch function is not really useful outside of ACLs. Currently only http
15442 basic auth is supported.
15443
Thierry FOURNIER9eec0a62014-01-22 18:38:02 +010015444http_auth_group(<userlist>) : string
15445 Returns a string corresponding to the user name found in the authentication
15446 data received from the client if both the user name and password are valid
15447 according to the specified userlist. The main purpose is to use it in ACLs
15448 where it is then checked whether the user belongs to any group within a list.
Willy Tarreau74ca5042013-06-11 23:12:07 +020015449 This fetch function is not really useful outside of ACLs. Currently only http
15450 basic auth is supported.
15451
15452 ACL derivatives :
Thierry FOURNIER9eec0a62014-01-22 18:38:02 +010015453 http_auth_group(<userlist>) : group ...
15454 Returns true when the user extracted from the request and whose password is
15455 valid according to the specified userlist belongs to at least one of the
15456 groups.
Willy Tarreau74ca5042013-06-11 23:12:07 +020015457
15458http_first_req : boolean
Willy Tarreau7f18e522010-10-22 20:04:13 +020015459 Returns true when the request being processed is the first one of the
15460 connection. This can be used to add or remove headers that may be missing
Willy Tarreau74ca5042013-06-11 23:12:07 +020015461 from some requests when a request is not the first one, or to help grouping
15462 requests in the logs.
Willy Tarreau7f18e522010-10-22 20:04:13 +020015463
Willy Tarreau74ca5042013-06-11 23:12:07 +020015464method : integer + string
15465 Returns an integer value corresponding to the method in the HTTP request. For
15466 example, "GET" equals 1 (check sources to establish the matching). Value 9
15467 means "other method" and may be converted to a string extracted from the
15468 stream. This should not be used directly as a sample, this is only meant to
15469 be used from ACLs, which transparently convert methods from patterns to these
15470 integer + string values. Some predefined ACL already check for most common
15471 methods.
Willy Tarreau6a06a402007-07-15 20:15:28 +020015472
Willy Tarreau74ca5042013-06-11 23:12:07 +020015473 ACL derivatives :
15474 method : case insensitive method match
Willy Tarreau6a06a402007-07-15 20:15:28 +020015475
Willy Tarreau74ca5042013-06-11 23:12:07 +020015476 Example :
15477 # only accept GET and HEAD requests
15478 acl valid_method method GET HEAD
15479 http-request deny if ! valid_method
Willy Tarreau6a06a402007-07-15 20:15:28 +020015480
Willy Tarreau74ca5042013-06-11 23:12:07 +020015481path : string
15482 This extracts the request's URL path, which starts at the first slash and
15483 ends before the question mark (without the host part). A typical use is with
15484 prefetch-capable caches, and with portals which need to aggregate multiple
15485 information from databases and keep them in caches. Note that with outgoing
15486 caches, it would be wiser to use "url" instead. With ACLs, it's typically
Davor Ocelice9ed2812017-12-25 17:49:28 +010015487 used to match exact file names (e.g. "/login.php"), or directory parts using
Willy Tarreau74ca5042013-06-11 23:12:07 +020015488 the derivative forms. See also the "url" and "base" fetch methods.
Willy Tarreau6a06a402007-07-15 20:15:28 +020015489
Willy Tarreau74ca5042013-06-11 23:12:07 +020015490 ACL derivatives :
15491 path : exact string match
15492 path_beg : prefix match
15493 path_dir : subdir match
15494 path_dom : domain match
15495 path_end : suffix match
15496 path_len : length match
15497 path_reg : regex match
15498 path_sub : substring match
Willy Tarreau6a06a402007-07-15 20:15:28 +020015499
Willy Tarreau49ad95c2015-01-19 15:06:26 +010015500query : string
15501 This extracts the request's query string, which starts after the first
15502 question mark. If no question mark is present, this fetch returns nothing. If
15503 a question mark is present but nothing follows, it returns an empty string.
15504 This means it's possible to easily know whether a query string is present
Tim Düsterhus4896c442016-11-29 02:15:19 +010015505 using the "found" matching method. This fetch is the complement of "path"
Willy Tarreau49ad95c2015-01-19 15:06:26 +010015506 which stops before the question mark.
15507
Willy Tarreaueb27ec72015-02-20 13:55:29 +010015508req.hdr_names([<delim>]) : string
15509 This builds a string made from the concatenation of all header names as they
15510 appear in the request when the rule is evaluated. The default delimiter is
15511 the comma (',') but it may be overridden as an optional argument <delim>. In
15512 this case, only the first character of <delim> is considered.
15513
Willy Tarreau74ca5042013-06-11 23:12:07 +020015514req.ver : string
15515req_ver : string (deprecated)
15516 Returns the version string from the HTTP request, for example "1.1". This can
15517 be useful for logs, but is mostly there for ACL. Some predefined ACL already
15518 check for versions 1.0 and 1.1.
Willy Tarreaud63335a2010-02-26 12:56:52 +010015519
Willy Tarreau74ca5042013-06-11 23:12:07 +020015520 ACL derivatives :
15521 req_ver : exact string match
Willy Tarreau0e698542011-09-16 08:32:32 +020015522
Willy Tarreau74ca5042013-06-11 23:12:07 +020015523res.comp : boolean
15524 Returns the boolean "true" value if the response has been compressed by
15525 HAProxy, otherwise returns boolean "false". This may be used to add
15526 information in the logs.
Willy Tarreau6a06a402007-07-15 20:15:28 +020015527
Willy Tarreau74ca5042013-06-11 23:12:07 +020015528res.comp_algo : string
15529 Returns a string containing the name of the algorithm used if the response
15530 was compressed by HAProxy, for example : "deflate". This may be used to add
15531 some information in the logs.
Willy Tarreaud63335a2010-02-26 12:56:52 +010015532
Willy Tarreau74ca5042013-06-11 23:12:07 +020015533res.cook([<name>]) : string
15534scook([<name>]) : string (deprecated)
15535 This extracts the last occurrence of the cookie name <name> on a "Set-Cookie"
15536 header line from the response, and returns its value as string. If no name is
15537 specified, the first cookie value is returned.
Willy Tarreau0ce3aa02012-04-25 18:46:33 +020015538
Willy Tarreau74ca5042013-06-11 23:12:07 +020015539 ACL derivatives :
15540 scook([<name>] : exact string match
Willy Tarreau0ce3aa02012-04-25 18:46:33 +020015541
Willy Tarreau74ca5042013-06-11 23:12:07 +020015542res.cook_cnt([<name>]) : integer
15543scook_cnt([<name>]) : integer (deprecated)
15544 Returns an integer value representing the number of occurrences of the cookie
15545 <name> in the response, or all cookies if <name> is not specified. This is
15546 mostly useful when combined with ACLs to detect suspicious responses.
Willy Tarreaud63335a2010-02-26 12:56:52 +010015547
Willy Tarreau74ca5042013-06-11 23:12:07 +020015548res.cook_val([<name>]) : integer
15549scook_val([<name>]) : integer (deprecated)
15550 This extracts the last occurrence of the cookie name <name> on a "Set-Cookie"
15551 header line from the response, and converts its value to an integer which is
15552 returned. If no name is specified, the first cookie value is returned.
Willy Tarreaud63335a2010-02-26 12:56:52 +010015553
Willy Tarreau74ca5042013-06-11 23:12:07 +020015554res.fhdr([<name>[,<occ>]]) : string
15555 This extracts the last occurrence of header <name> in an HTTP response, or of
15556 the last header if no <name> is specified. Optionally, a specific occurrence
15557 might be specified as a position number. Positive values indicate a position
15558 from the first occurrence, with 1 being the first one. Negative values
15559 indicate positions relative to the last one, with -1 being the last one. It
15560 differs from res.hdr() in that any commas present in the value are returned
15561 and are not used as delimiters. If this is not desired, the res.hdr() fetch
15562 should be used instead. This is sometimes useful with headers such as Date or
15563 Expires.
Willy Tarreau6a06a402007-07-15 20:15:28 +020015564
Willy Tarreau74ca5042013-06-11 23:12:07 +020015565res.fhdr_cnt([<name>]) : integer
15566 Returns an integer value representing the number of occurrences of response
15567 header field name <name>, or the total number of header fields if <name> is
15568 not specified. Contrary to its res.hdr_cnt() cousin, this function returns
15569 the number of full line headers and does not stop on commas. If this is not
15570 desired, the res.hdr_cnt() fetch should be used instead.
Willy Tarreau6a06a402007-07-15 20:15:28 +020015571
Willy Tarreau74ca5042013-06-11 23:12:07 +020015572res.hdr([<name>[,<occ>]]) : string
15573shdr([<name>[,<occ>]]) : string (deprecated)
15574 This extracts the last occurrence of header <name> in an HTTP response, or of
15575 the last header if no <name> is specified. Optionally, a specific occurrence
15576 might be specified as a position number. Positive values indicate a position
15577 from the first occurrence, with 1 being the first one. Negative values
15578 indicate positions relative to the last one, with -1 being the last one. This
15579 can be useful to learn some data into a stick-table. The function considers
15580 any comma as a delimiter for distinct values. If this is not desired, the
15581 res.fhdr() fetch should be used instead.
Willy Tarreau6a06a402007-07-15 20:15:28 +020015582
Willy Tarreau74ca5042013-06-11 23:12:07 +020015583 ACL derivatives :
15584 shdr([<name>[,<occ>]]) : exact string match
15585 shdr_beg([<name>[,<occ>]]) : prefix match
15586 shdr_dir([<name>[,<occ>]]) : subdir match
15587 shdr_dom([<name>[,<occ>]]) : domain match
15588 shdr_end([<name>[,<occ>]]) : suffix match
15589 shdr_len([<name>[,<occ>]]) : length match
15590 shdr_reg([<name>[,<occ>]]) : regex match
15591 shdr_sub([<name>[,<occ>]]) : substring match
15592
15593res.hdr_cnt([<name>]) : integer
15594shdr_cnt([<name>]) : integer (deprecated)
15595 Returns an integer value representing the number of occurrences of response
15596 header field name <name>, or the total number of header fields if <name> is
15597 not specified. The function considers any comma as a delimiter for distinct
15598 values. If this is not desired, the res.fhdr_cnt() fetch should be used
15599 instead.
Willy Tarreau6a06a402007-07-15 20:15:28 +020015600
Willy Tarreau74ca5042013-06-11 23:12:07 +020015601res.hdr_ip([<name>[,<occ>]]) : ip
15602shdr_ip([<name>[,<occ>]]) : ip (deprecated)
15603 This extracts the last occurrence of header <name> in an HTTP response,
15604 convert it to an IPv4 or IPv6 address and returns this address. Optionally, a
15605 specific occurrence might be specified as a position number. Positive values
15606 indicate a position from the first occurrence, with 1 being the first one.
15607 Negative values indicate positions relative to the last one, with -1 being
15608 the last one. This can be useful to learn some data into a stick table.
Willy Tarreau6a06a402007-07-15 20:15:28 +020015609
Willy Tarreaueb27ec72015-02-20 13:55:29 +010015610res.hdr_names([<delim>]) : string
15611 This builds a string made from the concatenation of all header names as they
15612 appear in the response when the rule is evaluated. The default delimiter is
15613 the comma (',') but it may be overridden as an optional argument <delim>. In
15614 this case, only the first character of <delim> is considered.
15615
Willy Tarreau74ca5042013-06-11 23:12:07 +020015616res.hdr_val([<name>[,<occ>]]) : integer
15617shdr_val([<name>[,<occ>]]) : integer (deprecated)
15618 This extracts the last occurrence of header <name> in an HTTP response, and
15619 converts it to an integer value. Optionally, a specific occurrence might be
15620 specified as a position number. Positive values indicate a position from the
15621 first occurrence, with 1 being the first one. Negative values indicate
15622 positions relative to the last one, with -1 being the last one. This can be
15623 useful to learn some data into a stick table.
Alexandre Cassen5eb1a902007-11-29 15:43:32 +010015624
Willy Tarreau74ca5042013-06-11 23:12:07 +020015625res.ver : string
15626resp_ver : string (deprecated)
15627 Returns the version string from the HTTP response, for example "1.1". This
15628 can be useful for logs, but is mostly there for ACL.
Willy Tarreau0e698542011-09-16 08:32:32 +020015629
Willy Tarreau74ca5042013-06-11 23:12:07 +020015630 ACL derivatives :
15631 resp_ver : exact string match
Alexandre Cassen5eb1a902007-11-29 15:43:32 +010015632
Willy Tarreau74ca5042013-06-11 23:12:07 +020015633set-cookie([<name>]) : string (deprecated)
15634 This extracts the last occurrence of the cookie name <name> on a "Set-Cookie"
15635 header line from the response and uses the corresponding value to match. This
Willy Tarreau294d0f02015-08-10 19:40:12 +020015636 can be comparable to what "appsession" did with default options, but with
Willy Tarreau74ca5042013-06-11 23:12:07 +020015637 support for multi-peer synchronization and state keeping across restarts.
Krzysztof Piotr Oledzki6b35ce12010-02-01 23:35:44 +010015638
Willy Tarreau74ca5042013-06-11 23:12:07 +020015639 This fetch function is deprecated and has been superseded by the "res.cook"
15640 fetch. This keyword will disappear soon.
Krzysztof Piotr Oledzki6b35ce12010-02-01 23:35:44 +010015641
Willy Tarreau74ca5042013-06-11 23:12:07 +020015642status : integer
15643 Returns an integer containing the HTTP status code in the HTTP response, for
15644 example, 302. It is mostly used within ACLs and integer ranges, for example,
15645 to remove any Location header if the response is not a 3xx.
Willy Tarreau25c1ebc2012-04-25 16:21:44 +020015646
Thierry Fournier0e00dca2016-04-07 15:47:40 +020015647unique-id : string
15648 Returns the unique-id attached to the request. The directive
15649 "unique-id-format" must be set. If it is not set, the unique-id sample fetch
15650 fails. Note that the unique-id is usually used with HTTP requests, however this
15651 sample fetch can be used with other protocols. Obviously, if it is used with
15652 other protocols than HTTP, the unique-id-format directive must not contain
15653 HTTP parts. See: unique-id-format and unique-id-header
15654
Willy Tarreau74ca5042013-06-11 23:12:07 +020015655url : string
15656 This extracts the request's URL as presented in the request. A typical use is
15657 with prefetch-capable caches, and with portals which need to aggregate
15658 multiple information from databases and keep them in caches. With ACLs, using
15659 "path" is preferred over using "url", because clients may send a full URL as
15660 is normally done with proxies. The only real use is to match "*" which does
15661 not match in "path", and for which there is already a predefined ACL. See
15662 also "path" and "base".
Willy Tarreau25c1ebc2012-04-25 16:21:44 +020015663
Willy Tarreau74ca5042013-06-11 23:12:07 +020015664 ACL derivatives :
15665 url : exact string match
15666 url_beg : prefix match
15667 url_dir : subdir match
15668 url_dom : domain match
15669 url_end : suffix match
15670 url_len : length match
15671 url_reg : regex match
15672 url_sub : substring match
Willy Tarreau25c1ebc2012-04-25 16:21:44 +020015673
Willy Tarreau74ca5042013-06-11 23:12:07 +020015674url_ip : ip
15675 This extracts the IP address from the request's URL when the host part is
15676 presented as an IP address. Its use is very limited. For instance, a
15677 monitoring system might use this field as an alternative for the source IP in
15678 order to test what path a given source address would follow, or to force an
15679 entry in a table for a given source address. With ACLs it can be used to
15680 restrict access to certain systems through a proxy, for example when combined
15681 with option "http_proxy".
Willy Tarreau25c1ebc2012-04-25 16:21:44 +020015682
Willy Tarreau74ca5042013-06-11 23:12:07 +020015683url_port : integer
15684 This extracts the port part from the request's URL. Note that if the port is
15685 not specified in the request, port 80 is assumed. With ACLs it can be used to
15686 restrict access to certain systems through a proxy, for example when combined
15687 with option "http_proxy".
Willy Tarreau25c1ebc2012-04-25 16:21:44 +020015688
Willy Tarreau1ede1da2015-05-07 16:06:18 +020015689urlp([<name>[,<delim>]]) : string
15690url_param([<name>[,<delim>]]) : string
Willy Tarreau74ca5042013-06-11 23:12:07 +020015691 This extracts the first occurrence of the parameter <name> in the query
15692 string, which begins after either '?' or <delim>, and which ends before '&',
Willy Tarreau1ede1da2015-05-07 16:06:18 +020015693 ';' or <delim>. The parameter name is case-sensitive. If no name is given,
15694 any parameter will match, and the first one will be returned. The result is
15695 a string corresponding to the value of the parameter <name> as presented in
15696 the request (no URL decoding is performed). This can be used for session
Willy Tarreau74ca5042013-06-11 23:12:07 +020015697 stickiness based on a client ID, to extract an application cookie passed as a
15698 URL parameter, or in ACLs to apply some checks. Note that the ACL version of
Willy Tarreau1ede1da2015-05-07 16:06:18 +020015699 this fetch iterates over multiple parameters and will iteratively report all
15700 parameters values if no name is given
Willy Tarreau25c1ebc2012-04-25 16:21:44 +020015701
Willy Tarreau74ca5042013-06-11 23:12:07 +020015702 ACL derivatives :
15703 urlp(<name>[,<delim>]) : exact string match
15704 urlp_beg(<name>[,<delim>]) : prefix match
15705 urlp_dir(<name>[,<delim>]) : subdir match
15706 urlp_dom(<name>[,<delim>]) : domain match
15707 urlp_end(<name>[,<delim>]) : suffix match
15708 urlp_len(<name>[,<delim>]) : length match
15709 urlp_reg(<name>[,<delim>]) : regex match
15710 urlp_sub(<name>[,<delim>]) : substring match
Willy Tarreau25c1ebc2012-04-25 16:21:44 +020015711
Willy Tarreau25c1ebc2012-04-25 16:21:44 +020015712
Willy Tarreau74ca5042013-06-11 23:12:07 +020015713 Example :
15714 # match http://example.com/foo?PHPSESSIONID=some_id
15715 stick on urlp(PHPSESSIONID)
15716 # match http://example.com/foo;JSESSIONID=some_id
15717 stick on urlp(JSESSIONID,;)
Willy Tarreau25c1ebc2012-04-25 16:21:44 +020015718
Jarno Huuskonen676f6222017-03-30 09:19:45 +030015719urlp_val([<name>[,<delim>]]) : integer
Willy Tarreau74ca5042013-06-11 23:12:07 +020015720 See "urlp" above. This one extracts the URL parameter <name> in the request
15721 and converts it to an integer value. This can be used for session stickiness
15722 based on a user ID for example, or with ACLs to match a page number or price.
Willy Tarreaua9fddca2012-07-31 07:51:48 +020015723
Dragan Dosen0070cd52016-06-16 12:19:49 +020015724url32 : integer
15725 This returns a 32-bit hash of the value obtained by concatenating the first
15726 Host header and the whole URL including parameters (not only the path part of
15727 the request, as in the "base32" fetch above). This is useful to track per-URL
15728 activity. A shorter hash is stored, saving a lot of memory. The output type
15729 is an unsigned integer.
15730
15731url32+src : binary
15732 This returns the concatenation of the "url32" fetch and the "src" fetch. The
15733 resulting type is of type binary, with a size of 8 or 20 bytes depending on
15734 the source address family. This can be used to track per-IP, per-URL counters.
15735
Willy Tarreau198a7442008-01-17 12:05:32 +010015736
Willy Tarreau74ca5042013-06-11 23:12:07 +0200157377.4. Pre-defined ACLs
Willy Tarreauc57f0e22009-05-10 13:12:33 +020015738---------------------
Willy Tarreauced27012008-01-17 20:35:34 +010015739
Willy Tarreauc57f0e22009-05-10 13:12:33 +020015740Some predefined ACLs are hard-coded so that they do not have to be declared in
15741every frontend which needs them. They all have their names in upper case in
Patrick Mézard2382ad62010-05-09 10:43:32 +020015742order to avoid confusion. Their equivalence is provided below.
Willy Tarreauced27012008-01-17 20:35:34 +010015743
Willy Tarreauc57f0e22009-05-10 13:12:33 +020015744ACL name Equivalent to Usage
15745---------------+-----------------------------+---------------------------------
Willy Tarreauc57f0e22009-05-10 13:12:33 +020015746FALSE always_false never match
Willy Tarreau2492d5b2009-07-11 00:06:00 +020015747HTTP req_proto_http match if protocol is valid HTTP
Willy Tarreauc57f0e22009-05-10 13:12:33 +020015748HTTP_1.0 req_ver 1.0 match HTTP version 1.0
15749HTTP_1.1 req_ver 1.1 match HTTP version 1.1
Willy Tarreaud63335a2010-02-26 12:56:52 +010015750HTTP_CONTENT hdr_val(content-length) gt 0 match an existing content-length
15751HTTP_URL_ABS url_reg ^[^/:]*:// match absolute URL with scheme
15752HTTP_URL_SLASH url_beg / match URL beginning with "/"
15753HTTP_URL_STAR url * match URL equal to "*"
15754LOCALHOST src 127.0.0.1/8 match connection from local host
Willy Tarreauc57f0e22009-05-10 13:12:33 +020015755METH_CONNECT method CONNECT match HTTP CONNECT method
Daniel Schneller9ff96c72016-04-11 17:45:29 +020015756METH_DELETE method DELETE match HTTP DELETE method
Willy Tarreauc57f0e22009-05-10 13:12:33 +020015757METH_GET method GET HEAD match HTTP GET or HEAD method
15758METH_HEAD method HEAD match HTTP HEAD method
15759METH_OPTIONS method OPTIONS match HTTP OPTIONS method
15760METH_POST method POST match HTTP POST method
Daniel Schneller9ff96c72016-04-11 17:45:29 +020015761METH_PUT method PUT match HTTP PUT method
Willy Tarreauc57f0e22009-05-10 13:12:33 +020015762METH_TRACE method TRACE match HTTP TRACE method
Emeric Brunbede3d02009-06-30 17:54:00 +020015763RDP_COOKIE req_rdp_cookie_cnt gt 0 match presence of an RDP cookie
Willy Tarreauc57f0e22009-05-10 13:12:33 +020015764REQ_CONTENT req_len gt 0 match data in the request buffer
Willy Tarreaud63335a2010-02-26 12:56:52 +010015765TRUE always_true always match
Willy Tarreauc57f0e22009-05-10 13:12:33 +020015766WAIT_END wait_end wait for end of content analysis
15767---------------+-----------------------------+---------------------------------
Willy Tarreauced27012008-01-17 20:35:34 +010015768
Willy Tarreaub937b7e2010-01-12 15:27:54 +010015769
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200157708. Logging
15771----------
Willy Tarreau844e3c52008-01-11 16:28:18 +010015772
Willy Tarreaucc6c8912009-02-22 10:53:55 +010015773One of HAProxy's strong points certainly lies is its precise logs. It probably
15774provides the finest level of information available for such a product, which is
15775very important for troubleshooting complex environments. Standard information
15776provided in logs include client ports, TCP/HTTP state timers, precise session
15777state at termination and precise termination cause, information about decisions
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +010015778to direct traffic to a server, and of course the ability to capture arbitrary
Willy Tarreaucc6c8912009-02-22 10:53:55 +010015779headers.
15780
15781In order to improve administrators reactivity, it offers a great transparency
15782about encountered problems, both internal and external, and it is possible to
15783send logs to different sources at the same time with different level filters :
15784
15785 - global process-level logs (system errors, start/stop, etc..)
15786 - per-instance system and internal errors (lack of resource, bugs, ...)
15787 - per-instance external troubles (servers up/down, max connections)
15788 - per-instance activity (client connections), either at the establishment or
15789 at the termination.
Davor Ocelice9ed2812017-12-25 17:49:28 +010015790 - per-request control of log-level, e.g.
Jim Freeman9e8714b2015-05-26 09:16:34 -060015791 http-request set-log-level silent if sensitive_request
Willy Tarreaucc6c8912009-02-22 10:53:55 +010015792
15793The ability to distribute different levels of logs to different log servers
15794allow several production teams to interact and to fix their problems as soon
15795as possible. For example, the system team might monitor system-wide errors,
15796while the application team might be monitoring the up/down for their servers in
15797real time, and the security team might analyze the activity logs with one hour
15798delay.
15799
15800
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200158018.1. Log levels
15802---------------
Willy Tarreaucc6c8912009-02-22 10:53:55 +010015803
Simon Hormandf791f52011-05-29 15:01:10 +090015804TCP and HTTP connections can be logged with information such as the date, time,
Willy Tarreaucc6c8912009-02-22 10:53:55 +010015805source IP address, destination address, connection duration, response times,
Simon Hormandf791f52011-05-29 15:01:10 +090015806HTTP request, HTTP return code, number of bytes transmitted, conditions
15807in which the session ended, and even exchanged cookies values. For example
15808track a particular user's problems. All messages may be sent to up to two
15809syslog servers. Check the "log" keyword in section 4.2 for more information
15810about log facilities.
Willy Tarreaucc6c8912009-02-22 10:53:55 +010015811
15812
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200158138.2. Log formats
15814----------------
Willy Tarreaucc6c8912009-02-22 10:53:55 +010015815
William Lallemand48940402012-01-30 16:47:22 +010015816HAProxy supports 5 log formats. Several fields are common between these formats
Simon Hormandf791f52011-05-29 15:01:10 +090015817and will be detailed in the following sections. A few of them may vary
15818slightly with the configuration, due to indicators specific to certain
15819options. The supported formats are as follows :
Willy Tarreaucc6c8912009-02-22 10:53:55 +010015820
15821 - the default format, which is very basic and very rarely used. It only
15822 provides very basic information about the incoming connection at the moment
15823 it is accepted : source IP:port, destination IP:port, and frontend-name.
15824 This mode will eventually disappear so it will not be described to great
15825 extents.
15826
15827 - the TCP format, which is more advanced. This format is enabled when "option
15828 tcplog" is set on the frontend. HAProxy will then usually wait for the
15829 connection to terminate before logging. This format provides much richer
15830 information, such as timers, connection counts, queue size, etc... This
15831 format is recommended for pure TCP proxies.
15832
15833 - the HTTP format, which is the most advanced for HTTP proxying. This format
15834 is enabled when "option httplog" is set on the frontend. It provides the
15835 same information as the TCP format with some HTTP-specific fields such as
15836 the request, the status code, and captures of headers and cookies. This
15837 format is recommended for HTTP proxies.
15838
Emeric Brun3a058f32009-06-30 18:26:00 +020015839 - the CLF HTTP format, which is equivalent to the HTTP format, but with the
15840 fields arranged in the same order as the CLF format. In this mode, all
15841 timers, captures, flags, etc... appear one per field after the end of the
15842 common fields, in the same order they appear in the standard HTTP format.
15843
William Lallemand48940402012-01-30 16:47:22 +010015844 - the custom log format, allows you to make your own log line.
15845
Willy Tarreaucc6c8912009-02-22 10:53:55 +010015846Next sections will go deeper into details for each of these formats. Format
15847specification will be performed on a "field" basis. Unless stated otherwise, a
15848field is a portion of text delimited by any number of spaces. Since syslog
15849servers are susceptible of inserting fields at the beginning of a line, it is
15850always assumed that the first field is the one containing the process name and
15851identifier.
15852
15853Note : Since log lines may be quite long, the log examples in sections below
15854 might be broken into multiple lines. The example log lines will be
15855 prefixed with 3 closing angle brackets ('>>>') and each time a log is
15856 broken into multiple lines, each non-final line will end with a
15857 backslash ('\') and the next line will start indented by two characters.
15858
15859
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200158608.2.1. Default log format
15861-------------------------
Willy Tarreaucc6c8912009-02-22 10:53:55 +010015862
15863This format is used when no specific option is set. The log is emitted as soon
15864as the connection is accepted. One should note that this currently is the only
15865format which logs the request's destination IP and ports.
15866
15867 Example :
15868 listen www
15869 mode http
15870 log global
15871 server srv1 127.0.0.1:8000
15872
15873 >>> Feb 6 12:12:09 localhost \
15874 haproxy[14385]: Connect from 10.0.1.2:33312 to 10.0.3.31:8012 \
15875 (www/HTTP)
15876
15877 Field Format Extract from the example above
15878 1 process_name '[' pid ']:' haproxy[14385]:
15879 2 'Connect from' Connect from
15880 3 source_ip ':' source_port 10.0.1.2:33312
15881 4 'to' to
15882 5 destination_ip ':' destination_port 10.0.3.31:8012
15883 6 '(' frontend_name '/' mode ')' (www/HTTP)
15884
15885Detailed fields description :
15886 - "source_ip" is the IP address of the client which initiated the connection.
15887 - "source_port" is the TCP port of the client which initiated the connection.
15888 - "destination_ip" is the IP address the client connected to.
15889 - "destination_port" is the TCP port the client connected to.
15890 - "frontend_name" is the name of the frontend (or listener) which received
15891 and processed the connection.
15892 - "mode is the mode the frontend is operating (TCP or HTTP).
15893
Willy Tarreauceb24bc2010-11-09 12:46:41 +010015894In case of a UNIX socket, the source and destination addresses are marked as
15895"unix:" and the ports reflect the internal ID of the socket which accepted the
15896connection (the same ID as reported in the stats).
15897
Willy Tarreaucc6c8912009-02-22 10:53:55 +010015898It is advised not to use this deprecated format for newer installations as it
15899will eventually disappear.
15900
15901
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200159028.2.2. TCP log format
15903---------------------
Willy Tarreaucc6c8912009-02-22 10:53:55 +010015904
15905The TCP format is used when "option tcplog" is specified in the frontend, and
15906is the recommended format for pure TCP proxies. It provides a lot of precious
15907information for troubleshooting. Since this format includes timers and byte
15908counts, the log is normally emitted at the end of the session. It can be
15909emitted earlier if "option logasap" is specified, which makes sense in most
15910environments with long sessions such as remote terminals. Sessions which match
15911the "monitor" rules are never logged. It is also possible not to emit logs for
15912sessions for which no data were exchanged between the client and the server, by
Willy Tarreauc9bd0cc2009-05-10 11:57:02 +020015913specifying "option dontlognull" in the frontend. Successful connections will
15914not be logged if "option dontlog-normal" is specified in the frontend. A few
15915fields may slightly vary depending on some configuration options, those are
15916marked with a star ('*') after the field name below.
Willy Tarreaucc6c8912009-02-22 10:53:55 +010015917
15918 Example :
15919 frontend fnt
15920 mode tcp
15921 option tcplog
15922 log global
15923 default_backend bck
15924
15925 backend bck
15926 server srv1 127.0.0.1:8000
15927
15928 >>> Feb 6 12:12:56 localhost \
15929 haproxy[14387]: 10.0.1.2:33313 [06/Feb/2009:12:12:51.443] fnt \
15930 bck/srv1 0/0/5007 212 -- 0/0/0/0/3 0/0
15931
15932 Field Format Extract from the example above
15933 1 process_name '[' pid ']:' haproxy[14387]:
15934 2 client_ip ':' client_port 10.0.1.2:33313
15935 3 '[' accept_date ']' [06/Feb/2009:12:12:51.443]
15936 4 frontend_name fnt
15937 5 backend_name '/' server_name bck/srv1
15938 6 Tw '/' Tc '/' Tt* 0/0/5007
15939 7 bytes_read* 212
15940 8 termination_state --
15941 9 actconn '/' feconn '/' beconn '/' srv_conn '/' retries* 0/0/0/0/3
15942 10 srv_queue '/' backend_queue 0/0
15943
15944Detailed fields description :
15945 - "client_ip" is the IP address of the client which initiated the TCP
Willy Tarreauceb24bc2010-11-09 12:46:41 +010015946 connection to haproxy. If the connection was accepted on a UNIX socket
15947 instead, the IP address would be replaced with the word "unix". Note that
15948 when the connection is accepted on a socket configured with "accept-proxy"
Bertrand Jacquin93b227d2016-06-04 15:11:10 +010015949 and the PROXY protocol is correctly used, or with a "accept-netscaler-cip"
Davor Ocelice9ed2812017-12-25 17:49:28 +010015950 and the NetScaler Client IP insertion protocol is correctly used, then the
Bertrand Jacquin93b227d2016-06-04 15:11:10 +010015951 logs will reflect the forwarded connection's information.
Willy Tarreaucc6c8912009-02-22 10:53:55 +010015952
15953 - "client_port" is the TCP port of the client which initiated the connection.
Willy Tarreauceb24bc2010-11-09 12:46:41 +010015954 If the connection was accepted on a UNIX socket instead, the port would be
15955 replaced with the ID of the accepting socket, which is also reported in the
15956 stats interface.
Willy Tarreaucc6c8912009-02-22 10:53:55 +010015957
15958 - "accept_date" is the exact date when the connection was received by haproxy
15959 (which might be very slightly different from the date observed on the
15960 network if there was some queuing in the system's backlog). This is usually
15961 the same date which may appear in any upstream firewall's log.
15962
15963 - "frontend_name" is the name of the frontend (or listener) which received
15964 and processed the connection.
15965
15966 - "backend_name" is the name of the backend (or listener) which was selected
15967 to manage the connection to the server. This will be the same as the
15968 frontend if no switching rule has been applied, which is common for TCP
15969 applications.
15970
15971 - "server_name" is the name of the last server to which the connection was
15972 sent, which might differ from the first one if there were connection errors
15973 and a redispatch occurred. Note that this server belongs to the backend
15974 which processed the request. If the connection was aborted before reaching
15975 a server, "<NOSRV>" is indicated instead of a server name.
15976
15977 - "Tw" is the total time in milliseconds spent waiting in the various queues.
15978 It can be "-1" if the connection was aborted before reaching the queue.
15979 See "Timers" below for more details.
15980
15981 - "Tc" is the total time in milliseconds spent waiting for the connection to
15982 establish to the final server, including retries. It can be "-1" if the
15983 connection was aborted before a connection could be established. See
15984 "Timers" below for more details.
15985
15986 - "Tt" is the total time in milliseconds elapsed between the accept and the
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030015987 last close. It covers all possible processing. There is one exception, if
Willy Tarreaucc6c8912009-02-22 10:53:55 +010015988 "option logasap" was specified, then the time counting stops at the moment
15989 the log is emitted. In this case, a '+' sign is prepended before the value,
15990 indicating that the final one will be larger. See "Timers" below for more
15991 details.
15992
15993 - "bytes_read" is the total number of bytes transmitted from the server to
15994 the client when the log is emitted. If "option logasap" is specified, the
15995 this value will be prefixed with a '+' sign indicating that the final one
15996 may be larger. Please note that this value is a 64-bit counter, so log
15997 analysis tools must be able to handle it without overflowing.
15998
15999 - "termination_state" is the condition the session was in when the session
16000 ended. This indicates the session state, which side caused the end of
16001 session to happen, and for what reason (timeout, error, ...). The normal
16002 flags should be "--", indicating the session was closed by either end with
16003 no data remaining in buffers. See below "Session state at disconnection"
16004 for more details.
16005
16006 - "actconn" is the total number of concurrent connections on the process when
Jamie Gloudonaaa21002012-08-25 00:18:33 -040016007 the session was logged. It is useful to detect when some per-process system
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016008 limits have been reached. For instance, if actconn is close to 512 when
16009 multiple connection errors occur, chances are high that the system limits
16010 the process to use a maximum of 1024 file descriptors and that all of them
Willy Tarreauc57f0e22009-05-10 13:12:33 +020016011 are used. See section 3 "Global parameters" to find how to tune the system.
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016012
16013 - "feconn" is the total number of concurrent connections on the frontend when
16014 the session was logged. It is useful to estimate the amount of resource
16015 required to sustain high loads, and to detect when the frontend's "maxconn"
16016 has been reached. Most often when this value increases by huge jumps, it is
16017 because there is congestion on the backend servers, but sometimes it can be
16018 caused by a denial of service attack.
16019
16020 - "beconn" is the total number of concurrent connections handled by the
16021 backend when the session was logged. It includes the total number of
16022 concurrent connections active on servers as well as the number of
16023 connections pending in queues. It is useful to estimate the amount of
16024 additional servers needed to support high loads for a given application.
16025 Most often when this value increases by huge jumps, it is because there is
16026 congestion on the backend servers, but sometimes it can be caused by a
16027 denial of service attack.
16028
16029 - "srv_conn" is the total number of concurrent connections still active on
16030 the server when the session was logged. It can never exceed the server's
16031 configured "maxconn" parameter. If this value is very often close or equal
16032 to the server's "maxconn", it means that traffic regulation is involved a
16033 lot, meaning that either the server's maxconn value is too low, or that
16034 there aren't enough servers to process the load with an optimal response
16035 time. When only one of the server's "srv_conn" is high, it usually means
16036 that this server has some trouble causing the connections to take longer to
16037 be processed than on other servers.
16038
16039 - "retries" is the number of connection retries experienced by this session
16040 when trying to connect to the server. It must normally be zero, unless a
16041 server is being stopped at the same moment the connection was attempted.
16042 Frequent retries generally indicate either a network problem between
16043 haproxy and the server, or a misconfigured system backlog on the server
16044 preventing new connections from being queued. This field may optionally be
16045 prefixed with a '+' sign, indicating that the session has experienced a
16046 redispatch after the maximal retry count has been reached on the initial
16047 server. In this case, the server name appearing in the log is the one the
16048 connection was redispatched to, and not the first one, though both may
16049 sometimes be the same in case of hashing for instance. So as a general rule
16050 of thumb, when a '+' is present in front of the retry count, this count
16051 should not be attributed to the logged server.
16052
16053 - "srv_queue" is the total number of requests which were processed before
16054 this one in the server queue. It is zero when the request has not gone
16055 through the server queue. It makes it possible to estimate the approximate
16056 server's response time by dividing the time spent in queue by the number of
16057 requests in the queue. It is worth noting that if a session experiences a
16058 redispatch and passes through two server queues, their positions will be
Davor Ocelice9ed2812017-12-25 17:49:28 +010016059 cumulative. A request should not pass through both the server queue and the
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016060 backend queue unless a redispatch occurs.
16061
16062 - "backend_queue" is the total number of requests which were processed before
16063 this one in the backend's global queue. It is zero when the request has not
16064 gone through the global queue. It makes it possible to estimate the average
16065 queue length, which easily translates into a number of missing servers when
16066 divided by a server's "maxconn" parameter. It is worth noting that if a
16067 session experiences a redispatch, it may pass twice in the backend's queue,
Davor Ocelice9ed2812017-12-25 17:49:28 +010016068 and then both positions will be cumulative. A request should not pass
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016069 through both the server queue and the backend queue unless a redispatch
16070 occurs.
16071
16072
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200160738.2.3. HTTP log format
16074----------------------
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016075
16076The HTTP format is the most complete and the best suited for HTTP proxies. It
16077is enabled by when "option httplog" is specified in the frontend. It provides
16078the same level of information as the TCP format with additional features which
16079are specific to the HTTP protocol. Just like the TCP format, the log is usually
16080emitted at the end of the session, unless "option logasap" is specified, which
16081generally only makes sense for download sites. A session which matches the
16082"monitor" rules will never logged. It is also possible not to log sessions for
16083which no data were sent by the client by specifying "option dontlognull" in the
Willy Tarreauc9bd0cc2009-05-10 11:57:02 +020016084frontend. Successful connections will not be logged if "option dontlog-normal"
16085is specified in the frontend.
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016086
16087Most fields are shared with the TCP log, some being different. A few fields may
16088slightly vary depending on some configuration options. Those ones are marked
16089with a star ('*') after the field name below.
16090
16091 Example :
16092 frontend http-in
16093 mode http
16094 option httplog
16095 log global
16096 default_backend bck
16097
16098 backend static
16099 server srv1 127.0.0.1:8000
16100
16101 >>> Feb 6 12:14:14 localhost \
16102 haproxy[14389]: 10.0.1.2:33317 [06/Feb/2009:12:14:14.655] http-in \
16103 static/srv1 10/0/30/69/109 200 2750 - - ---- 1/1/1/1/0 0/0 {1wt.eu} \
Willy Tarreaud72758d2010-01-12 10:42:19 +010016104 {} "GET /index.html HTTP/1.1"
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016105
16106 Field Format Extract from the example above
16107 1 process_name '[' pid ']:' haproxy[14389]:
16108 2 client_ip ':' client_port 10.0.1.2:33317
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016109 3 '[' request_date ']' [06/Feb/2009:12:14:14.655]
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016110 4 frontend_name http-in
16111 5 backend_name '/' server_name static/srv1
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016112 6 TR '/' Tw '/' Tc '/' Tr '/' Ta* 10/0/30/69/109
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016113 7 status_code 200
16114 8 bytes_read* 2750
16115 9 captured_request_cookie -
16116 10 captured_response_cookie -
16117 11 termination_state ----
16118 12 actconn '/' feconn '/' beconn '/' srv_conn '/' retries* 1/1/1/1/0
16119 13 srv_queue '/' backend_queue 0/0
16120 14 '{' captured_request_headers* '}' {haproxy.1wt.eu}
16121 15 '{' captured_response_headers* '}' {}
16122 16 '"' http_request '"' "GET /index.html HTTP/1.1"
Willy Tarreaud72758d2010-01-12 10:42:19 +010016123
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016124Detailed fields description :
16125 - "client_ip" is the IP address of the client which initiated the TCP
Willy Tarreauceb24bc2010-11-09 12:46:41 +010016126 connection to haproxy. If the connection was accepted on a UNIX socket
16127 instead, the IP address would be replaced with the word "unix". Note that
16128 when the connection is accepted on a socket configured with "accept-proxy"
Bertrand Jacquin93b227d2016-06-04 15:11:10 +010016129 and the PROXY protocol is correctly used, or with a "accept-netscaler-cip"
Davor Ocelice9ed2812017-12-25 17:49:28 +010016130 and the NetScaler Client IP insertion protocol is correctly used, then the
Bertrand Jacquin93b227d2016-06-04 15:11:10 +010016131 logs will reflect the forwarded connection's information.
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016132
16133 - "client_port" is the TCP port of the client which initiated the connection.
Willy Tarreauceb24bc2010-11-09 12:46:41 +010016134 If the connection was accepted on a UNIX socket instead, the port would be
16135 replaced with the ID of the accepting socket, which is also reported in the
16136 stats interface.
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016137
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016138 - "request_date" is the exact date when the first byte of the HTTP request
16139 was received by haproxy (log field %tr).
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016140
16141 - "frontend_name" is the name of the frontend (or listener) which received
16142 and processed the connection.
16143
16144 - "backend_name" is the name of the backend (or listener) which was selected
16145 to manage the connection to the server. This will be the same as the
16146 frontend if no switching rule has been applied.
16147
16148 - "server_name" is the name of the last server to which the connection was
16149 sent, which might differ from the first one if there were connection errors
16150 and a redispatch occurred. Note that this server belongs to the backend
16151 which processed the request. If the request was aborted before reaching a
16152 server, "<NOSRV>" is indicated instead of a server name. If the request was
16153 intercepted by the stats subsystem, "<STATS>" is indicated instead.
16154
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016155 - "TR" is the total time in milliseconds spent waiting for a full HTTP
16156 request from the client (not counting body) after the first byte was
16157 received. It can be "-1" if the connection was aborted before a complete
16158 request could be received or the a bad request was received. It should
16159 always be very small because a request generally fits in one single packet.
16160 Large times here generally indicate network issues between the client and
16161 haproxy or requests being typed by hand. See "Timers" below for more details.
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016162
16163 - "Tw" is the total time in milliseconds spent waiting in the various queues.
16164 It can be "-1" if the connection was aborted before reaching the queue.
16165 See "Timers" below for more details.
16166
16167 - "Tc" is the total time in milliseconds spent waiting for the connection to
16168 establish to the final server, including retries. It can be "-1" if the
16169 request was aborted before a connection could be established. See "Timers"
16170 below for more details.
16171
16172 - "Tr" is the total time in milliseconds spent waiting for the server to send
16173 a full HTTP response, not counting data. It can be "-1" if the request was
16174 aborted before a complete response could be received. It generally matches
16175 the server's processing time for the request, though it may be altered by
16176 the amount of data sent by the client to the server. Large times here on
16177 "GET" requests generally indicate an overloaded server. See "Timers" below
16178 for more details.
16179
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016180 - "Ta" is the time the request remained active in haproxy, which is the total
16181 time in milliseconds elapsed between the first byte of the request was
16182 received and the last byte of response was sent. It covers all possible
16183 processing except the handshake (see Th) and idle time (see Ti). There is
16184 one exception, if "option logasap" was specified, then the time counting
16185 stops at the moment the log is emitted. In this case, a '+' sign is
16186 prepended before the value, indicating that the final one will be larger.
16187 See "Timers" below for more details.
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016188
16189 - "status_code" is the HTTP status code returned to the client. This status
16190 is generally set by the server, but it might also be set by haproxy when
16191 the server cannot be reached or when its response is blocked by haproxy.
16192
16193 - "bytes_read" is the total number of bytes transmitted to the client when
16194 the log is emitted. This does include HTTP headers. If "option logasap" is
16195 specified, the this value will be prefixed with a '+' sign indicating that
16196 the final one may be larger. Please note that this value is a 64-bit
16197 counter, so log analysis tools must be able to handle it without
16198 overflowing.
16199
16200 - "captured_request_cookie" is an optional "name=value" entry indicating that
16201 the client had this cookie in the request. The cookie name and its maximum
16202 length are defined by the "capture cookie" statement in the frontend
16203 configuration. The field is a single dash ('-') when the option is not
16204 set. Only one cookie may be captured, it is generally used to track session
16205 ID exchanges between a client and a server to detect session crossing
16206 between clients due to application bugs. For more details, please consult
16207 the section "Capturing HTTP headers and cookies" below.
16208
16209 - "captured_response_cookie" is an optional "name=value" entry indicating
16210 that the server has returned a cookie with its response. The cookie name
16211 and its maximum length are defined by the "capture cookie" statement in the
16212 frontend configuration. The field is a single dash ('-') when the option is
16213 not set. Only one cookie may be captured, it is generally used to track
16214 session ID exchanges between a client and a server to detect session
16215 crossing between clients due to application bugs. For more details, please
16216 consult the section "Capturing HTTP headers and cookies" below.
16217
16218 - "termination_state" is the condition the session was in when the session
16219 ended. This indicates the session state, which side caused the end of
16220 session to happen, for what reason (timeout, error, ...), just like in TCP
16221 logs, and information about persistence operations on cookies in the last
16222 two characters. The normal flags should begin with "--", indicating the
16223 session was closed by either end with no data remaining in buffers. See
16224 below "Session state at disconnection" for more details.
16225
16226 - "actconn" is the total number of concurrent connections on the process when
Jamie Gloudonaaa21002012-08-25 00:18:33 -040016227 the session was logged. It is useful to detect when some per-process system
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016228 limits have been reached. For instance, if actconn is close to 512 or 1024
16229 when multiple connection errors occur, chances are high that the system
16230 limits the process to use a maximum of 1024 file descriptors and that all
Willy Tarreauc57f0e22009-05-10 13:12:33 +020016231 of them are used. See section 3 "Global parameters" to find how to tune the
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016232 system.
16233
16234 - "feconn" is the total number of concurrent connections on the frontend when
16235 the session was logged. It is useful to estimate the amount of resource
16236 required to sustain high loads, and to detect when the frontend's "maxconn"
16237 has been reached. Most often when this value increases by huge jumps, it is
16238 because there is congestion on the backend servers, but sometimes it can be
16239 caused by a denial of service attack.
16240
16241 - "beconn" is the total number of concurrent connections handled by the
16242 backend when the session was logged. It includes the total number of
16243 concurrent connections active on servers as well as the number of
16244 connections pending in queues. It is useful to estimate the amount of
16245 additional servers needed to support high loads for a given application.
16246 Most often when this value increases by huge jumps, it is because there is
16247 congestion on the backend servers, but sometimes it can be caused by a
16248 denial of service attack.
16249
16250 - "srv_conn" is the total number of concurrent connections still active on
16251 the server when the session was logged. It can never exceed the server's
16252 configured "maxconn" parameter. If this value is very often close or equal
16253 to the server's "maxconn", it means that traffic regulation is involved a
16254 lot, meaning that either the server's maxconn value is too low, or that
16255 there aren't enough servers to process the load with an optimal response
16256 time. When only one of the server's "srv_conn" is high, it usually means
16257 that this server has some trouble causing the requests to take longer to be
16258 processed than on other servers.
16259
16260 - "retries" is the number of connection retries experienced by this session
16261 when trying to connect to the server. It must normally be zero, unless a
16262 server is being stopped at the same moment the connection was attempted.
16263 Frequent retries generally indicate either a network problem between
16264 haproxy and the server, or a misconfigured system backlog on the server
16265 preventing new connections from being queued. This field may optionally be
16266 prefixed with a '+' sign, indicating that the session has experienced a
16267 redispatch after the maximal retry count has been reached on the initial
16268 server. In this case, the server name appearing in the log is the one the
16269 connection was redispatched to, and not the first one, though both may
16270 sometimes be the same in case of hashing for instance. So as a general rule
16271 of thumb, when a '+' is present in front of the retry count, this count
16272 should not be attributed to the logged server.
16273
16274 - "srv_queue" is the total number of requests which were processed before
16275 this one in the server queue. It is zero when the request has not gone
16276 through the server queue. It makes it possible to estimate the approximate
16277 server's response time by dividing the time spent in queue by the number of
16278 requests in the queue. It is worth noting that if a session experiences a
16279 redispatch and passes through two server queues, their positions will be
Davor Ocelice9ed2812017-12-25 17:49:28 +010016280 cumulative. A request should not pass through both the server queue and the
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016281 backend queue unless a redispatch occurs.
16282
16283 - "backend_queue" is the total number of requests which were processed before
16284 this one in the backend's global queue. It is zero when the request has not
16285 gone through the global queue. It makes it possible to estimate the average
16286 queue length, which easily translates into a number of missing servers when
16287 divided by a server's "maxconn" parameter. It is worth noting that if a
16288 session experiences a redispatch, it may pass twice in the backend's queue,
Davor Ocelice9ed2812017-12-25 17:49:28 +010016289 and then both positions will be cumulative. A request should not pass
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016290 through both the server queue and the backend queue unless a redispatch
16291 occurs.
16292
16293 - "captured_request_headers" is a list of headers captured in the request due
16294 to the presence of the "capture request header" statement in the frontend.
16295 Multiple headers can be captured, they will be delimited by a vertical bar
16296 ('|'). When no capture is enabled, the braces do not appear, causing a
16297 shift of remaining fields. It is important to note that this field may
16298 contain spaces, and that using it requires a smarter log parser than when
16299 it's not used. Please consult the section "Capturing HTTP headers and
16300 cookies" below for more details.
16301
16302 - "captured_response_headers" is a list of headers captured in the response
16303 due to the presence of the "capture response header" statement in the
16304 frontend. Multiple headers can be captured, they will be delimited by a
16305 vertical bar ('|'). When no capture is enabled, the braces do not appear,
16306 causing a shift of remaining fields. It is important to note that this
16307 field may contain spaces, and that using it requires a smarter log parser
16308 than when it's not used. Please consult the section "Capturing HTTP headers
16309 and cookies" below for more details.
16310
16311 - "http_request" is the complete HTTP request line, including the method,
16312 request and HTTP version string. Non-printable characters are encoded (see
16313 below the section "Non-printable characters"). This is always the last
16314 field, and it is always delimited by quotes and is the only one which can
16315 contain quotes. If new fields are added to the log format, they will be
16316 added before this field. This field might be truncated if the request is
16317 huge and does not fit in the standard syslog buffer (1024 characters). This
16318 is the reason why this field must always remain the last one.
16319
16320
Cyril Bontédc4d9032012-04-08 21:57:39 +0200163218.2.4. Custom log format
16322------------------------
William Lallemand48940402012-01-30 16:47:22 +010016323
Willy Tarreau2beef582012-12-20 17:22:52 +010016324The directive log-format allows you to customize the logs in http mode and tcp
William Lallemandbddd4fd2012-02-27 11:23:10 +010016325mode. It takes a string as argument.
William Lallemand48940402012-01-30 16:47:22 +010016326
Davor Ocelice9ed2812017-12-25 17:49:28 +010016327HAProxy understands some log format variables. % precedes log format variables.
William Lallemand48940402012-01-30 16:47:22 +010016328Variables can take arguments using braces ('{}'), and multiple arguments are
16329separated by commas within the braces. Flags may be added or removed by
16330prefixing them with a '+' or '-' sign.
16331
16332Special variable "%o" may be used to propagate its flags to all other
16333variables on the same format string. This is particularly handy with quoted
Dragan Dosen835b9212016-02-12 13:23:03 +010016334("Q") and escaped ("E") string formats.
William Lallemand48940402012-01-30 16:47:22 +010016335
Willy Tarreauc8368452012-12-21 00:09:23 +010016336If a variable is named between square brackets ('[' .. ']') then it is used
Willy Tarreaube722a22014-06-13 16:31:59 +020016337as a sample expression rule (see section 7.3). This it useful to add some
Willy Tarreauc8368452012-12-21 00:09:23 +010016338less common information such as the client's SSL certificate's DN, or to log
16339the key that would be used to store an entry into a stick table.
16340
William Lallemand48940402012-01-30 16:47:22 +010016341Note: spaces must be escaped. A space character is considered as a separator.
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030016342In order to emit a verbatim '%', it must be preceded by another '%' resulting
Willy Tarreau06d97f92013-12-02 17:45:48 +010016343in '%%'. HAProxy will automatically merge consecutive separators.
William Lallemand48940402012-01-30 16:47:22 +010016344
Dragan Dosen835b9212016-02-12 13:23:03 +010016345Note: when using the RFC5424 syslog message format, the characters '"',
16346'\' and ']' inside PARAM-VALUE should be escaped with '\' as prefix (see
16347https://tools.ietf.org/html/rfc5424#section-6.3.3 for more details). In
16348such cases, the use of the flag "E" should be considered.
16349
William Lallemand48940402012-01-30 16:47:22 +010016350Flags are :
16351 * Q: quote a string
Jamie Gloudonaaa21002012-08-25 00:18:33 -040016352 * X: hexadecimal representation (IPs, Ports, %Ts, %rt, %pid)
Dragan Dosen835b9212016-02-12 13:23:03 +010016353 * E: escape characters '"', '\' and ']' in a string with '\' as prefix
16354 (intended purpose is for the RFC5424 structured-data log formats)
William Lallemand48940402012-01-30 16:47:22 +010016355
16356 Example:
16357
16358 log-format %T\ %t\ Some\ Text
16359 log-format %{+Q}o\ %t\ %s\ %{-Q}r
16360
Dragan Dosen835b9212016-02-12 13:23:03 +010016361 log-format-sd %{+Q,+E}o\ [exampleSDID@1234\ header=%[capture.req.hdr(0)]]
16362
William Lallemand48940402012-01-30 16:47:22 +010016363At the moment, the default HTTP format is defined this way :
16364
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016365 log-format "%ci:%cp [%tr] %ft %b/%s %TR/%Tw/%Tc/%Tr/%Ta %ST %B %CC \
16366 %CS %tsc %ac/%fc/%bc/%sc/%rc %sq/%bq %hr %hs %{+Q}r"
William Lallemand48940402012-01-30 16:47:22 +010016367
William Lallemandbddd4fd2012-02-27 11:23:10 +010016368the default CLF format is defined this way :
William Lallemand48940402012-01-30 16:47:22 +010016369
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016370 log-format "%{+Q}o %{-Q}ci - - [%trg] %r %ST %B \"\" \"\" %cp \
16371 %ms %ft %b %s %TR %Tw %Tc %Tr %Ta %tsc %ac %fc \
16372 %bc %sc %rc %sq %bq %CC %CS %hrl %hsl"
William Lallemand48940402012-01-30 16:47:22 +010016373
William Lallemandbddd4fd2012-02-27 11:23:10 +010016374and the default TCP format is defined this way :
16375
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016376 log-format "%ci:%cp [%t] %ft %b/%s %Tw/%Tc/%Tt %B %ts \
16377 %ac/%fc/%bc/%sc/%rc %sq/%bq"
William Lallemandbddd4fd2012-02-27 11:23:10 +010016378
William Lallemand48940402012-01-30 16:47:22 +010016379Please refer to the table below for currently defined variables :
16380
William Lallemandbddd4fd2012-02-27 11:23:10 +010016381 +---+------+-----------------------------------------------+-------------+
Willy Tarreauffc3fcd2012-10-12 20:17:54 +020016382 | R | var | field name (8.2.2 and 8.2.3 for description) | type |
William Lallemandbddd4fd2012-02-27 11:23:10 +010016383 +---+------+-----------------------------------------------+-------------+
16384 | | %o | special variable, apply flags on all next var | |
16385 +---+------+-----------------------------------------------+-------------+
Willy Tarreau2beef582012-12-20 17:22:52 +010016386 | | %B | bytes_read (from server to client) | numeric |
16387 | H | %CC | captured_request_cookie | string |
16388 | H | %CS | captured_response_cookie | string |
William Lallemand5f232402012-04-05 18:02:55 +020016389 | | %H | hostname | string |
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +000016390 | H | %HM | HTTP method (ex: POST) | string |
16391 | H | %HP | HTTP request URI without query string (path) | string |
Andrew Hayworthe63ac872015-07-31 16:14:16 +000016392 | H | %HQ | HTTP request URI query string (ex: ?bar=baz) | string |
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +000016393 | H | %HU | HTTP request URI (ex: /foo?bar=baz) | string |
16394 | H | %HV | HTTP version (ex: HTTP/1.0) | string |
William Lallemanda73203e2012-03-12 12:48:57 +010016395 | | %ID | unique-id | string |
Willy Tarreau4bf99632014-06-13 12:21:40 +020016396 | | %ST | status_code | numeric |
William Lallemand5f232402012-04-05 18:02:55 +020016397 | | %T | gmt_date_time | date |
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016398 | | %Ta | Active time of the request (from TR to end) | numeric |
William Lallemandbddd4fd2012-02-27 11:23:10 +010016399 | | %Tc | Tc | numeric |
Willy Tarreau27b639d2016-05-17 17:55:27 +020016400 | | %Td | Td = Tt - (Tq + Tw + Tc + Tr) | numeric |
Yuxans Yao4e25b012012-10-19 10:36:09 +080016401 | | %Tl | local_date_time | date |
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016402 | | %Th | connection handshake time (SSL, PROXY proto) | numeric |
16403 | H | %Ti | idle time before the HTTP request | numeric |
16404 | H | %Tq | Th + Ti + TR | numeric |
16405 | H | %TR | time to receive the full request from 1st byte| numeric |
16406 | H | %Tr | Tr (response time) | numeric |
William Lallemand5f232402012-04-05 18:02:55 +020016407 | | %Ts | timestamp | numeric |
William Lallemandbddd4fd2012-02-27 11:23:10 +010016408 | | %Tt | Tt | numeric |
16409 | | %Tw | Tw | numeric |
Willy Tarreau2beef582012-12-20 17:22:52 +010016410 | | %U | bytes_uploaded (from client to server) | numeric |
William Lallemandbddd4fd2012-02-27 11:23:10 +010016411 | | %ac | actconn | numeric |
16412 | | %b | backend_name | string |
Willy Tarreau2beef582012-12-20 17:22:52 +010016413 | | %bc | beconn (backend concurrent connections) | numeric |
16414 | | %bi | backend_source_ip (connecting address) | IP |
16415 | | %bp | backend_source_port (connecting address) | numeric |
William Lallemandbddd4fd2012-02-27 11:23:10 +010016416 | | %bq | backend_queue | numeric |
Willy Tarreau2beef582012-12-20 17:22:52 +010016417 | | %ci | client_ip (accepted address) | IP |
16418 | | %cp | client_port (accepted address) | numeric |
William Lallemandbddd4fd2012-02-27 11:23:10 +010016419 | | %f | frontend_name | string |
Willy Tarreau2beef582012-12-20 17:22:52 +010016420 | | %fc | feconn (frontend concurrent connections) | numeric |
16421 | | %fi | frontend_ip (accepting address) | IP |
16422 | | %fp | frontend_port (accepting address) | numeric |
Willy Tarreau773d65f2012-10-12 14:56:11 +020016423 | | %ft | frontend_name_transport ('~' suffix for SSL) | string |
Willy Tarreau7346acb2014-08-28 15:03:15 +020016424 | | %lc | frontend_log_counter | numeric |
Willy Tarreaud9ed3d22014-06-13 12:23:06 +020016425 | | %hr | captured_request_headers default style | string |
16426 | | %hrl | captured_request_headers CLF style | string list |
16427 | | %hs | captured_response_headers default style | string |
16428 | | %hsl | captured_response_headers CLF style | string list |
Willy Tarreau812c88e2015-08-09 10:56:35 +020016429 | | %ms | accept date milliseconds (left-padded with 0) | numeric |
William Lallemand5f232402012-04-05 18:02:55 +020016430 | | %pid | PID | numeric |
Willy Tarreauffc3fcd2012-10-12 20:17:54 +020016431 | H | %r | http_request | string |
William Lallemandbddd4fd2012-02-27 11:23:10 +010016432 | | %rc | retries | numeric |
Willy Tarreau1f0da242014-01-25 11:01:50 +010016433 | | %rt | request_counter (HTTP req or TCP session) | numeric |
William Lallemandbddd4fd2012-02-27 11:23:10 +010016434 | | %s | server_name | string |
Willy Tarreau2beef582012-12-20 17:22:52 +010016435 | | %sc | srv_conn (server concurrent connections) | numeric |
16436 | | %si | server_IP (target address) | IP |
16437 | | %sp | server_port (target address) | numeric |
William Lallemandbddd4fd2012-02-27 11:23:10 +010016438 | | %sq | srv_queue | numeric |
Willy Tarreauffc3fcd2012-10-12 20:17:54 +020016439 | S | %sslc| ssl_ciphers (ex: AES-SHA) | string |
16440 | S | %sslv| ssl_version (ex: TLSv1) | string |
Willy Tarreau2beef582012-12-20 17:22:52 +010016441 | | %t | date_time (with millisecond resolution) | date |
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016442 | H | %tr | date_time of HTTP request | date |
16443 | H | %trg | gmt_date_time of start of HTTP request | date |
Jens Bissinger15c64ff2018-08-23 14:11:27 +020016444 | H | %trl | local_date_time of start of HTTP request | date |
William Lallemandbddd4fd2012-02-27 11:23:10 +010016445 | | %ts | termination_state | string |
Willy Tarreauffc3fcd2012-10-12 20:17:54 +020016446 | H | %tsc | termination_state with cookie status | string |
William Lallemandbddd4fd2012-02-27 11:23:10 +010016447 +---+------+-----------------------------------------------+-------------+
William Lallemand48940402012-01-30 16:47:22 +010016448
Willy Tarreauffc3fcd2012-10-12 20:17:54 +020016449 R = Restrictions : H = mode http only ; S = SSL only
William Lallemand48940402012-01-30 16:47:22 +010016450
Willy Tarreau5f51e1a2012-12-03 18:40:10 +010016451
164528.2.5. Error log format
16453-----------------------
16454
16455When an incoming connection fails due to an SSL handshake or an invalid PROXY
16456protocol header, haproxy will log the event using a shorter, fixed line format.
16457By default, logs are emitted at the LOG_INFO level, unless the option
16458"log-separate-errors" is set in the backend, in which case the LOG_ERR level
Davor Ocelice9ed2812017-12-25 17:49:28 +010016459will be used. Connections on which no data are exchanged (e.g. probes) are not
Willy Tarreau5f51e1a2012-12-03 18:40:10 +010016460logged if the "dontlognull" option is set.
16461
16462The format looks like this :
16463
16464 >>> Dec 3 18:27:14 localhost \
16465 haproxy[6103]: 127.0.0.1:56059 [03/Dec/2012:17:35:10.380] frt/f1: \
16466 Connection error during SSL handshake
16467
16468 Field Format Extract from the example above
16469 1 process_name '[' pid ']:' haproxy[6103]:
16470 2 client_ip ':' client_port 127.0.0.1:56059
16471 3 '[' accept_date ']' [03/Dec/2012:17:35:10.380]
16472 4 frontend_name "/" bind_name ":" frt/f1:
16473 5 message Connection error during SSL handshake
16474
16475These fields just provide minimal information to help debugging connection
16476failures.
16477
16478
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200164798.3. Advanced logging options
16480-----------------------------
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016481
16482Some advanced logging options are often looked for but are not easy to find out
16483just by looking at the various options. Here is an entry point for the few
16484options which can enable better logging. Please refer to the keywords reference
16485for more information about their usage.
16486
16487
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200164888.3.1. Disabling logging of external tests
16489------------------------------------------
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016490
16491It is quite common to have some monitoring tools perform health checks on
16492haproxy. Sometimes it will be a layer 3 load-balancer such as LVS or any
16493commercial load-balancer, and sometimes it will simply be a more complete
16494monitoring system such as Nagios. When the tests are very frequent, users often
16495ask how to disable logging for those checks. There are three possibilities :
16496
16497 - if connections come from everywhere and are just TCP probes, it is often
16498 desired to simply disable logging of connections without data exchange, by
16499 setting "option dontlognull" in the frontend. It also disables logging of
16500 port scans, which may or may not be desired.
16501
16502 - if the connection come from a known source network, use "monitor-net" to
16503 declare this network as monitoring only. Any host in this network will then
16504 only be able to perform health checks, and their requests will not be
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030016505 logged. This is generally appropriate to designate a list of equipment
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016506 such as other load-balancers.
16507
16508 - if the tests are performed on a known URI, use "monitor-uri" to declare
16509 this URI as dedicated to monitoring. Any host sending this request will
16510 only get the result of a health-check, and the request will not be logged.
16511
16512
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200165138.3.2. Logging before waiting for the session to terminate
16514----------------------------------------------------------
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016515
16516The problem with logging at end of connection is that you have no clue about
16517what is happening during very long sessions, such as remote terminal sessions
16518or large file downloads. This problem can be worked around by specifying
Davor Ocelice9ed2812017-12-25 17:49:28 +010016519"option logasap" in the frontend. HAProxy will then log as soon as possible,
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016520just before data transfer begins. This means that in case of TCP, it will still
16521log the connection status to the server, and in case of HTTP, it will log just
16522after processing the server headers. In this case, the number of bytes reported
16523is the number of header bytes sent to the client. In order to avoid confusion
16524with normal logs, the total time field and the number of bytes are prefixed
16525with a '+' sign which means that real numbers are certainly larger.
16526
16527
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200165288.3.3. Raising log level upon errors
16529------------------------------------
Willy Tarreauc9bd0cc2009-05-10 11:57:02 +020016530
16531Sometimes it is more convenient to separate normal traffic from errors logs,
16532for instance in order to ease error monitoring from log files. When the option
16533"log-separate-errors" is used, connections which experience errors, timeouts,
16534retries, redispatches or HTTP status codes 5xx will see their syslog level
16535raised from "info" to "err". This will help a syslog daemon store the log in
16536a separate file. It is very important to keep the errors in the normal traffic
16537file too, so that log ordering is not altered. You should also be careful if
16538you already have configured your syslog daemon to store all logs higher than
16539"notice" in an "admin" file, because the "err" level is higher than "notice".
16540
16541
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200165428.3.4. Disabling logging of successful connections
16543--------------------------------------------------
Willy Tarreauc9bd0cc2009-05-10 11:57:02 +020016544
16545Although this may sound strange at first, some large sites have to deal with
16546multiple thousands of logs per second and are experiencing difficulties keeping
16547them intact for a long time or detecting errors within them. If the option
16548"dontlog-normal" is set on the frontend, all normal connections will not be
16549logged. In this regard, a normal connection is defined as one without any
16550error, timeout, retry nor redispatch. In HTTP, the status code is checked too,
16551and a response with a status 5xx is not considered normal and will be logged
16552too. Of course, doing is is really discouraged as it will remove most of the
16553useful information from the logs. Do this only if you have no other
16554alternative.
16555
16556
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200165578.4. Timing events
16558------------------
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016559
16560Timers provide a great help in troubleshooting network problems. All values are
16561reported in milliseconds (ms). These timers should be used in conjunction with
16562the session termination flags. In TCP mode with "option tcplog" set on the
16563frontend, 3 control points are reported under the form "Tw/Tc/Tt", and in HTTP
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016564mode, 5 control points are reported under the form "TR/Tw/Tc/Tr/Ta". In
16565addition, three other measures are provided, "Th", "Ti", and "Tq".
16566
Guillaume de Lafondf27cddc2016-12-23 17:32:43 +010016567Timings events in HTTP mode:
16568
16569 first request 2nd request
16570 |<-------------------------------->|<-------------- ...
16571 t tr t tr ...
16572 ---|----|----|----|----|----|----|----|----|--
16573 : Th Ti TR Tw Tc Tr Td : Ti ...
16574 :<---- Tq ---->: :
16575 :<-------------- Tt -------------->:
16576 :<--------- Ta --------->:
16577
16578Timings events in TCP mode:
16579
16580 TCP session
16581 |<----------------->|
16582 t t
16583 ---|----|----|----|----|---
16584 | Th Tw Tc Td |
16585 |<------ Tt ------->|
16586
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016587 - Th: total time to accept tcp connection and execute handshakes for low level
Davor Ocelice9ed2812017-12-25 17:49:28 +010016588 protocols. Currently, these protocols are proxy-protocol and SSL. This may
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016589 only happen once during the whole connection's lifetime. A large time here
16590 may indicate that the client only pre-established the connection without
16591 speaking, that it is experiencing network issues preventing it from
Davor Ocelice9ed2812017-12-25 17:49:28 +010016592 completing a handshake in a reasonable time (e.g. MTU issues), or that an
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016593 SSL handshake was very expensive to compute.
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016594
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016595 - Ti: is the idle time before the HTTP request (HTTP mode only). This timer
16596 counts between the end of the handshakes and the first byte of the HTTP
16597 request. When dealing with a second request in keep-alive mode, it starts
16598 to count after the end of the transmission the previous response. Some
16599 browsers pre-establish connections to a server in order to reduce the
16600 latency of a future request, and keep them pending until they need it. This
16601 delay will be reported as the idle time. A value of -1 indicates that
16602 nothing was received on the connection.
16603
16604 - TR: total time to get the client request (HTTP mode only). It's the time
16605 elapsed between the first bytes received and the moment the proxy received
16606 the empty line marking the end of the HTTP headers. The value "-1"
16607 indicates that the end of headers has never been seen. This happens when
16608 the client closes prematurely or times out. This time is usually very short
16609 since most requests fit in a single packet. A large time may indicate a
16610 request typed by hand during a test.
16611
16612 - Tq: total time to get the client request from the accept date or since the
16613 emission of the last byte of the previous response (HTTP mode only). It's
Davor Ocelice9ed2812017-12-25 17:49:28 +010016614 exactly equal to Th + Ti + TR unless any of them is -1, in which case it
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016615 returns -1 as well. This timer used to be very useful before the arrival of
16616 HTTP keep-alive and browsers' pre-connect feature. It's recommended to drop
16617 it in favor of TR nowadays, as the idle time adds a lot of noise to the
16618 reports.
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016619
16620 - Tw: total time spent in the queues waiting for a connection slot. It
16621 accounts for backend queue as well as the server queues, and depends on the
16622 queue size, and the time needed for the server to complete previous
16623 requests. The value "-1" means that the request was killed before reaching
16624 the queue, which is generally what happens with invalid or denied requests.
16625
16626 - Tc: total time to establish the TCP connection to the server. It's the time
16627 elapsed between the moment the proxy sent the connection request, and the
16628 moment it was acknowledged by the server, or between the TCP SYN packet and
16629 the matching SYN/ACK packet in return. The value "-1" means that the
16630 connection never established.
16631
16632 - Tr: server response time (HTTP mode only). It's the time elapsed between
16633 the moment the TCP connection was established to the server and the moment
16634 the server sent its complete response headers. It purely shows its request
16635 processing time, without the network overhead due to the data transmission.
16636 It is worth noting that when the client has data to send to the server, for
16637 instance during a POST request, the time already runs, and this can distort
16638 apparent response time. For this reason, it's generally wise not to trust
16639 too much this field for POST requests initiated from clients behind an
16640 untrusted network. A value of "-1" here means that the last the response
16641 header (empty line) was never seen, most likely because the server timeout
16642 stroke before the server managed to process the request.
16643
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016644 - Ta: total active time for the HTTP request, between the moment the proxy
16645 received the first byte of the request header and the emission of the last
16646 byte of the response body. The exception is when the "logasap" option is
16647 specified. In this case, it only equals (TR+Tw+Tc+Tr), and is prefixed with
16648 a '+' sign. From this field, we can deduce "Td", the data transmission time,
16649 by subtracting other timers when valid :
16650
16651 Td = Ta - (TR + Tw + Tc + Tr)
16652
16653 Timers with "-1" values have to be excluded from this equation. Note that
16654 "Ta" can never be negative.
16655
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016656 - Tt: total session duration time, between the moment the proxy accepted it
16657 and the moment both ends were closed. The exception is when the "logasap"
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016658 option is specified. In this case, it only equals (Th+Ti+TR+Tw+Tc+Tr), and
16659 is prefixed with a '+' sign. From this field, we can deduce "Td", the data
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030016660 transmission time, by subtracting other timers when valid :
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016661
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016662 Td = Tt - (Th + Ti + TR + Tw + Tc + Tr)
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016663
16664 Timers with "-1" values have to be excluded from this equation. In TCP
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016665 mode, "Ti", "Tq" and "Tr" have to be excluded too. Note that "Tt" can never
16666 be negative and that for HTTP, Tt is simply equal to (Th+Ti+Ta).
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016667
16668These timers provide precious indications on trouble causes. Since the TCP
16669protocol defines retransmit delays of 3, 6, 12... seconds, we know for sure
16670that timers close to multiples of 3s are nearly always related to lost packets
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016671due to network problems (wires, negotiation, congestion). Moreover, if "Ta" or
16672"Tt" is close to a timeout value specified in the configuration, it often means
16673that a session has been aborted on timeout.
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016674
16675Most common cases :
16676
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016677 - If "Th" or "Ti" are close to 3000, a packet has probably been lost between
16678 the client and the proxy. This is very rare on local networks but might
16679 happen when clients are on far remote networks and send large requests. It
16680 may happen that values larger than usual appear here without any network
16681 cause. Sometimes, during an attack or just after a resource starvation has
16682 ended, haproxy may accept thousands of connections in a few milliseconds.
16683 The time spent accepting these connections will inevitably slightly delay
16684 processing of other connections, and it can happen that request times in the
16685 order of a few tens of milliseconds are measured after a few thousands of
16686 new connections have been accepted at once. Using one of the keep-alive
16687 modes may display larger idle times since "Ti" measures the time spent
Patrick Mezard105faca2010-06-12 17:02:46 +020016688 waiting for additional requests.
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016689
16690 - If "Tc" is close to 3000, a packet has probably been lost between the
16691 server and the proxy during the server connection phase. This value should
16692 always be very low, such as 1 ms on local networks and less than a few tens
16693 of ms on remote networks.
16694
Willy Tarreau55165fe2009-05-10 12:02:55 +020016695 - If "Tr" is nearly always lower than 3000 except some rare values which seem
16696 to be the average majored by 3000, there are probably some packets lost
16697 between the proxy and the server.
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016698
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016699 - If "Ta" is large even for small byte counts, it generally is because
16700 neither the client nor the server decides to close the connection while
16701 haproxy is running in tunnel mode and both have agreed on a keep-alive
16702 connection mode. In order to solve this issue, it will be needed to specify
16703 one of the HTTP options to manipulate keep-alive or close options on either
16704 the frontend or the backend. Having the smallest possible 'Ta' or 'Tt' is
16705 important when connection regulation is used with the "maxconn" option on
16706 the servers, since no new connection will be sent to the server until
16707 another one is released.
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016708
16709Other noticeable HTTP log cases ('xx' means any value to be ignored) :
16710
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016711 TR/Tw/Tc/Tr/+Ta The "option logasap" is present on the frontend and the log
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016712 was emitted before the data phase. All the timers are valid
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016713 except "Ta" which is shorter than reality.
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016714
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016715 -1/xx/xx/xx/Ta The client was not able to send a complete request in time
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016716 or it aborted too early. Check the session termination flags
16717 then "timeout http-request" and "timeout client" settings.
16718
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016719 TR/-1/xx/xx/Ta It was not possible to process the request, maybe because
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016720 servers were out of order, because the request was invalid
16721 or forbidden by ACL rules. Check the session termination
16722 flags.
16723
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016724 TR/Tw/-1/xx/Ta The connection could not establish on the server. Either it
16725 actively refused it or it timed out after Ta-(TR+Tw) ms.
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016726 Check the session termination flags, then check the
16727 "timeout connect" setting. Note that the tarpit action might
16728 return similar-looking patterns, with "Tw" equal to the time
16729 the client connection was maintained open.
16730
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016731 TR/Tw/Tc/-1/Ta The server has accepted the connection but did not return
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030016732 a complete response in time, or it closed its connection
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +020016733 unexpectedly after Ta-(TR+Tw+Tc) ms. Check the session
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016734 termination flags, then check the "timeout server" setting.
16735
16736
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200167378.5. Session state at disconnection
16738-----------------------------------
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016739
16740TCP and HTTP logs provide a session termination indicator in the
16741"termination_state" field, just before the number of active connections. It is
167422-characters long in TCP mode, and is extended to 4 characters in HTTP mode,
16743each of which has a special meaning :
16744
16745 - On the first character, a code reporting the first event which caused the
16746 session to terminate :
16747
16748 C : the TCP session was unexpectedly aborted by the client.
16749
16750 S : the TCP session was unexpectedly aborted by the server, or the
16751 server explicitly refused it.
16752
16753 P : the session was prematurely aborted by the proxy, because of a
16754 connection limit enforcement, because a DENY filter was matched,
16755 because of a security check which detected and blocked a dangerous
16756 error in server response which might have caused information leak
Davor Ocelice9ed2812017-12-25 17:49:28 +010016757 (e.g. cacheable cookie).
Willy Tarreau570f2212013-06-10 16:42:09 +020016758
16759 L : the session was locally processed by haproxy and was not passed to
16760 a server. This is what happens for stats and redirects.
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016761
16762 R : a resource on the proxy has been exhausted (memory, sockets, source
16763 ports, ...). Usually, this appears during the connection phase, and
16764 system logs should contain a copy of the precise error. If this
16765 happens, it must be considered as a very serious anomaly which
16766 should be fixed as soon as possible by any means.
16767
16768 I : an internal error was identified by the proxy during a self-check.
16769 This should NEVER happen, and you are encouraged to report any log
16770 containing this, because this would almost certainly be a bug. It
16771 would be wise to preventively restart the process after such an
16772 event too, in case it would be caused by memory corruption.
16773
Simon Horman752dc4a2011-06-21 14:34:59 +090016774 D : the session was killed by haproxy because the server was detected
16775 as down and was configured to kill all connections when going down.
16776
Justin Karnegeseb2c24a2012-05-24 15:28:52 -070016777 U : the session was killed by haproxy on this backup server because an
16778 active server was detected as up and was configured to kill all
16779 backup connections when going up.
16780
Willy Tarreaua2a64e92011-09-07 23:01:56 +020016781 K : the session was actively killed by an admin operating on haproxy.
16782
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016783 c : the client-side timeout expired while waiting for the client to
16784 send or receive data.
16785
16786 s : the server-side timeout expired while waiting for the server to
16787 send or receive data.
16788
16789 - : normal session completion, both the client and the server closed
16790 with nothing left in the buffers.
16791
16792 - on the second character, the TCP or HTTP session state when it was closed :
16793
Willy Tarreauf7b30a92010-12-06 22:59:17 +010016794 R : the proxy was waiting for a complete, valid REQUEST from the client
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016795 (HTTP mode only). Nothing was sent to any server.
16796
16797 Q : the proxy was waiting in the QUEUE for a connection slot. This can
16798 only happen when servers have a 'maxconn' parameter set. It can
16799 also happen in the global queue after a redispatch consecutive to
16800 a failed attempt to connect to a dying server. If no redispatch is
16801 reported, then no connection attempt was made to any server.
16802
16803 C : the proxy was waiting for the CONNECTION to establish on the
16804 server. The server might at most have noticed a connection attempt.
16805
16806 H : the proxy was waiting for complete, valid response HEADERS from the
16807 server (HTTP only).
16808
16809 D : the session was in the DATA phase.
16810
16811 L : the proxy was still transmitting LAST data to the client while the
16812 server had already finished. This one is very rare as it can only
16813 happen when the client dies while receiving the last packets.
16814
16815 T : the request was tarpitted. It has been held open with the client
16816 during the whole "timeout tarpit" duration or until the client
16817 closed, both of which will be reported in the "Tw" timer.
16818
16819 - : normal session completion after end of data transfer.
16820
16821 - the third character tells whether the persistence cookie was provided by
16822 the client (only in HTTP mode) :
16823
16824 N : the client provided NO cookie. This is usually the case for new
16825 visitors, so counting the number of occurrences of this flag in the
16826 logs generally indicate a valid trend for the site frequentation.
16827
16828 I : the client provided an INVALID cookie matching no known server.
16829 This might be caused by a recent configuration change, mixed
Cyril Bontéa8e7bbc2010-04-25 22:29:29 +020016830 cookies between HTTP/HTTPS sites, persistence conditionally
16831 ignored, or an attack.
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016832
16833 D : the client provided a cookie designating a server which was DOWN,
16834 so either "option persist" was used and the client was sent to
16835 this server, or it was not set and the client was redispatched to
16836 another server.
16837
Willy Tarreau996a92c2010-10-13 19:30:47 +020016838 V : the client provided a VALID cookie, and was sent to the associated
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016839 server.
16840
Willy Tarreau996a92c2010-10-13 19:30:47 +020016841 E : the client provided a valid cookie, but with a last date which was
16842 older than what is allowed by the "maxidle" cookie parameter, so
16843 the cookie is consider EXPIRED and is ignored. The request will be
16844 redispatched just as if there was no cookie.
16845
16846 O : the client provided a valid cookie, but with a first date which was
16847 older than what is allowed by the "maxlife" cookie parameter, so
16848 the cookie is consider too OLD and is ignored. The request will be
16849 redispatched just as if there was no cookie.
16850
Willy Tarreauc89ccb62012-04-05 21:18:22 +020016851 U : a cookie was present but was not used to select the server because
16852 some other server selection mechanism was used instead (typically a
16853 "use-server" rule).
16854
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016855 - : does not apply (no cookie set in configuration).
16856
16857 - the last character reports what operations were performed on the persistence
16858 cookie returned by the server (only in HTTP mode) :
16859
16860 N : NO cookie was provided by the server, and none was inserted either.
16861
16862 I : no cookie was provided by the server, and the proxy INSERTED one.
16863 Note that in "cookie insert" mode, if the server provides a cookie,
16864 it will still be overwritten and reported as "I" here.
16865
Willy Tarreau996a92c2010-10-13 19:30:47 +020016866 U : the proxy UPDATED the last date in the cookie that was presented by
16867 the client. This can only happen in insert mode with "maxidle". It
Jarno Huuskonen0e82b922014-04-12 18:22:19 +030016868 happens every time there is activity at a different date than the
Willy Tarreau996a92c2010-10-13 19:30:47 +020016869 date indicated in the cookie. If any other change happens, such as
16870 a redispatch, then the cookie will be marked as inserted instead.
16871
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016872 P : a cookie was PROVIDED by the server and transmitted as-is.
16873
16874 R : the cookie provided by the server was REWRITTEN by the proxy, which
16875 happens in "cookie rewrite" or "cookie prefix" modes.
16876
16877 D : the cookie provided by the server was DELETED by the proxy.
16878
16879 - : does not apply (no cookie set in configuration).
16880
Willy Tarreau996a92c2010-10-13 19:30:47 +020016881The combination of the two first flags gives a lot of information about what
16882was happening when the session terminated, and why it did terminate. It can be
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016883helpful to detect server saturation, network troubles, local system resource
16884starvation, attacks, etc...
16885
16886The most common termination flags combinations are indicated below. They are
16887alphabetically sorted, with the lowercase set just after the upper case for
16888easier finding and understanding.
16889
16890 Flags Reason
16891
16892 -- Normal termination.
16893
16894 CC The client aborted before the connection could be established to the
16895 server. This can happen when haproxy tries to connect to a recently
16896 dead (or unchecked) server, and the client aborts while haproxy is
16897 waiting for the server to respond or for "timeout connect" to expire.
16898
16899 CD The client unexpectedly aborted during data transfer. This can be
16900 caused by a browser crash, by an intermediate equipment between the
16901 client and haproxy which decided to actively break the connection,
16902 by network routing issues between the client and haproxy, or by a
16903 keep-alive session between the server and the client terminated first
16904 by the client.
Willy Tarreaud72758d2010-01-12 10:42:19 +010016905
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016906 cD The client did not send nor acknowledge any data for as long as the
16907 "timeout client" delay. This is often caused by network failures on
Cyril Bontédc4d9032012-04-08 21:57:39 +020016908 the client side, or the client simply leaving the net uncleanly.
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016909
16910 CH The client aborted while waiting for the server to start responding.
16911 It might be the server taking too long to respond or the client
16912 clicking the 'Stop' button too fast.
16913
16914 cH The "timeout client" stroke while waiting for client data during a
16915 POST request. This is sometimes caused by too large TCP MSS values
16916 for PPPoE networks which cannot transport full-sized packets. It can
16917 also happen when client timeout is smaller than server timeout and
16918 the server takes too long to respond.
16919
16920 CQ The client aborted while its session was queued, waiting for a server
16921 with enough empty slots to accept it. It might be that either all the
16922 servers were saturated or that the assigned server was taking too
16923 long a time to respond.
16924
16925 CR The client aborted before sending a full HTTP request. Most likely
16926 the request was typed by hand using a telnet client, and aborted
16927 too early. The HTTP status code is likely a 400 here. Sometimes this
16928 might also be caused by an IDS killing the connection between haproxy
Willy Tarreau0f228a02015-05-01 15:37:53 +020016929 and the client. "option http-ignore-probes" can be used to ignore
16930 connections without any data transfer.
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016931
16932 cR The "timeout http-request" stroke before the client sent a full HTTP
16933 request. This is sometimes caused by too large TCP MSS values on the
16934 client side for PPPoE networks which cannot transport full-sized
16935 packets, or by clients sending requests by hand and not typing fast
16936 enough, or forgetting to enter the empty line at the end of the
Willy Tarreau2705a612014-05-23 17:38:34 +020016937 request. The HTTP status code is likely a 408 here. Note: recently,
Willy Tarreau0f228a02015-05-01 15:37:53 +020016938 some browsers started to implement a "pre-connect" feature consisting
16939 in speculatively connecting to some recently visited web sites just
16940 in case the user would like to visit them. This results in many
16941 connections being established to web sites, which end up in 408
16942 Request Timeout if the timeout strikes first, or 400 Bad Request when
16943 the browser decides to close them first. These ones pollute the log
16944 and feed the error counters. Some versions of some browsers have even
16945 been reported to display the error code. It is possible to work
Davor Ocelice9ed2812017-12-25 17:49:28 +010016946 around the undesirable effects of this behavior by adding "option
Willy Tarreau0f228a02015-05-01 15:37:53 +020016947 http-ignore-probes" in the frontend, resulting in connections with
16948 zero data transfer to be totally ignored. This will definitely hide
16949 the errors of people experiencing connectivity issues though.
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016950
16951 CT The client aborted while its session was tarpitted. It is important to
16952 check if this happens on valid requests, in order to be sure that no
Willy Tarreau55165fe2009-05-10 12:02:55 +020016953 wrong tarpit rules have been written. If a lot of them happen, it
16954 might make sense to lower the "timeout tarpit" value to something
16955 closer to the average reported "Tw" timer, in order not to consume
16956 resources for just a few attackers.
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016957
Willy Tarreau570f2212013-06-10 16:42:09 +020016958 LR The request was intercepted and locally handled by haproxy. Generally
16959 it means that this was a redirect or a stats request.
16960
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +010016961 SC The server or an equipment between it and haproxy explicitly refused
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016962 the TCP connection (the proxy received a TCP RST or an ICMP message
16963 in return). Under some circumstances, it can also be the network
Davor Ocelice9ed2812017-12-25 17:49:28 +010016964 stack telling the proxy that the server is unreachable (e.g. no route,
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016965 or no ARP response on local network). When this happens in HTTP mode,
16966 the status code is likely a 502 or 503 here.
16967
16968 sC The "timeout connect" stroke before a connection to the server could
16969 complete. When this happens in HTTP mode, the status code is likely a
16970 503 or 504 here.
16971
16972 SD The connection to the server died with an error during the data
16973 transfer. This usually means that haproxy has received an RST from
16974 the server or an ICMP message from an intermediate equipment while
16975 exchanging data with the server. This can be caused by a server crash
16976 or by a network issue on an intermediate equipment.
16977
16978 sD The server did not send nor acknowledge any data for as long as the
16979 "timeout server" setting during the data phase. This is often caused
Davor Ocelice9ed2812017-12-25 17:49:28 +010016980 by too short timeouts on L4 equipment before the server (firewalls,
Willy Tarreaucc6c8912009-02-22 10:53:55 +010016981 load-balancers, ...), as well as keep-alive sessions maintained
16982 between the client and the server expiring first on haproxy.
16983
16984 SH The server aborted before sending its full HTTP response headers, or
16985 it crashed while processing the request. Since a server aborting at
16986 this moment is very rare, it would be wise to inspect its logs to
16987 control whether it crashed and why. The logged request may indicate a
16988 small set of faulty requests, demonstrating bugs in the application.
16989 Sometimes this might also be caused by an IDS killing the connection
16990 between haproxy and the server.
16991
16992 sH The "timeout server" stroke before the server could return its
16993 response headers. This is the most common anomaly, indicating too
16994 long transactions, probably caused by server or database saturation.
16995 The immediate workaround consists in increasing the "timeout server"
16996 setting, but it is important to keep in mind that the user experience
16997 will suffer from these long response times. The only long term
16998 solution is to fix the application.
16999
17000 sQ The session spent too much time in queue and has been expired. See
17001 the "timeout queue" and "timeout connect" settings to find out how to
17002 fix this if it happens too often. If it often happens massively in
17003 short periods, it may indicate general problems on the affected
17004 servers due to I/O or database congestion, or saturation caused by
17005 external attacks.
17006
17007 PC The proxy refused to establish a connection to the server because the
17008 process' socket limit has been reached while attempting to connect.
Cyril Bontédc4d9032012-04-08 21:57:39 +020017009 The global "maxconn" parameter may be increased in the configuration
Willy Tarreaucc6c8912009-02-22 10:53:55 +010017010 so that it does not happen anymore. This status is very rare and
17011 might happen when the global "ulimit-n" parameter is forced by hand.
17012
Willy Tarreaued2fd2d2010-12-29 11:23:27 +010017013 PD The proxy blocked an incorrectly formatted chunked encoded message in
17014 a request or a response, after the server has emitted its headers. In
17015 most cases, this will indicate an invalid message from the server to
Davor Ocelice9ed2812017-12-25 17:49:28 +010017016 the client. HAProxy supports chunk sizes of up to 2GB - 1 (2147483647
Willy Tarreauf3a3e132013-08-31 08:16:26 +020017017 bytes). Any larger size will be considered as an error.
Willy Tarreaued2fd2d2010-12-29 11:23:27 +010017018
Willy Tarreaucc6c8912009-02-22 10:53:55 +010017019 PH The proxy blocked the server's response, because it was invalid,
17020 incomplete, dangerous (cache control), or matched a security filter.
17021 In any case, an HTTP 502 error is sent to the client. One possible
17022 cause for this error is an invalid syntax in an HTTP header name
Willy Tarreaued2fd2d2010-12-29 11:23:27 +010017023 containing unauthorized characters. It is also possible but quite
17024 rare, that the proxy blocked a chunked-encoding request from the
17025 client due to an invalid syntax, before the server responded. In this
17026 case, an HTTP 400 error is sent to the client and reported in the
17027 logs.
Willy Tarreaucc6c8912009-02-22 10:53:55 +010017028
17029 PR The proxy blocked the client's HTTP request, either because of an
17030 invalid HTTP syntax, in which case it returned an HTTP 400 error to
17031 the client, or because a deny filter matched, in which case it
17032 returned an HTTP 403 error.
17033
17034 PT The proxy blocked the client's request and has tarpitted its
17035 connection before returning it a 500 server error. Nothing was sent
17036 to the server. The connection was maintained open for as long as
17037 reported by the "Tw" timer field.
17038
17039 RC A local resource has been exhausted (memory, sockets, source ports)
17040 preventing the connection to the server from establishing. The error
17041 logs will tell precisely what was missing. This is very rare and can
17042 only be solved by proper system tuning.
17043
Willy Tarreau996a92c2010-10-13 19:30:47 +020017044The combination of the two last flags gives a lot of information about how
17045persistence was handled by the client, the server and by haproxy. This is very
17046important to troubleshoot disconnections, when users complain they have to
17047re-authenticate. The commonly encountered flags are :
17048
17049 -- Persistence cookie is not enabled.
17050
17051 NN No cookie was provided by the client, none was inserted in the
17052 response. For instance, this can be in insert mode with "postonly"
17053 set on a GET request.
17054
17055 II A cookie designating an invalid server was provided by the client,
17056 a valid one was inserted in the response. This typically happens when
Jamie Gloudonaaa21002012-08-25 00:18:33 -040017057 a "server" entry is removed from the configuration, since its cookie
Willy Tarreau996a92c2010-10-13 19:30:47 +020017058 value can be presented by a client when no other server knows it.
17059
17060 NI No cookie was provided by the client, one was inserted in the
17061 response. This typically happens for first requests from every user
17062 in "insert" mode, which makes it an easy way to count real users.
17063
17064 VN A cookie was provided by the client, none was inserted in the
17065 response. This happens for most responses for which the client has
17066 already got a cookie.
17067
17068 VU A cookie was provided by the client, with a last visit date which is
17069 not completely up-to-date, so an updated cookie was provided in
17070 response. This can also happen if there was no date at all, or if
17071 there was a date but the "maxidle" parameter was not set, so that the
17072 cookie can be switched to unlimited time.
17073
17074 EI A cookie was provided by the client, with a last visit date which is
17075 too old for the "maxidle" parameter, so the cookie was ignored and a
17076 new cookie was inserted in the response.
17077
17078 OI A cookie was provided by the client, with a first visit date which is
17079 too old for the "maxlife" parameter, so the cookie was ignored and a
17080 new cookie was inserted in the response.
17081
17082 DI The server designated by the cookie was down, a new server was
17083 selected and a new cookie was emitted in the response.
17084
17085 VI The server designated by the cookie was not marked dead but could not
17086 be reached. A redispatch happened and selected another one, which was
17087 then advertised in the response.
17088
Willy Tarreaucc6c8912009-02-22 10:53:55 +010017089
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200170908.6. Non-printable characters
17091-----------------------------
Willy Tarreaucc6c8912009-02-22 10:53:55 +010017092
17093In order not to cause trouble to log analysis tools or terminals during log
17094consulting, non-printable characters are not sent as-is into log files, but are
17095converted to the two-digits hexadecimal representation of their ASCII code,
17096prefixed by the character '#'. The only characters that can be logged without
17097being escaped are comprised between 32 and 126 (inclusive). Obviously, the
17098escape character '#' itself is also encoded to avoid any ambiguity ("#23"). It
17099is the same for the character '"' which becomes "#22", as well as '{', '|' and
17100'}' when logging headers.
17101
17102Note that the space character (' ') is not encoded in headers, which can cause
17103issues for tools relying on space count to locate fields. A typical header
17104containing spaces is "User-Agent".
17105
17106Last, it has been observed that some syslog daemons such as syslog-ng escape
17107the quote ('"') with a backslash ('\'). The reverse operation can safely be
17108performed since no quote may appear anywhere else in the logs.
17109
17110
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200171118.7. Capturing HTTP cookies
17112---------------------------
Willy Tarreaucc6c8912009-02-22 10:53:55 +010017113
17114Cookie capture simplifies the tracking a complete user session. This can be
17115achieved using the "capture cookie" statement in the frontend. Please refer to
Willy Tarreauc57f0e22009-05-10 13:12:33 +020017116section 4.2 for more details. Only one cookie can be captured, and the same
Willy Tarreaucc6c8912009-02-22 10:53:55 +010017117cookie will simultaneously be checked in the request ("Cookie:" header) and in
17118the response ("Set-Cookie:" header). The respective values will be reported in
17119the HTTP logs at the "captured_request_cookie" and "captured_response_cookie"
Willy Tarreauc57f0e22009-05-10 13:12:33 +020017120locations (see section 8.2.3 about HTTP log format). When either cookie is
Willy Tarreaucc6c8912009-02-22 10:53:55 +010017121not seen, a dash ('-') replaces the value. This way, it's easy to detect when a
17122user switches to a new session for example, because the server will reassign it
17123a new cookie. It is also possible to detect if a server unexpectedly sets a
17124wrong cookie to a client, leading to session crossing.
17125
17126 Examples :
17127 # capture the first cookie whose name starts with "ASPSESSION"
17128 capture cookie ASPSESSION len 32
17129
17130 # capture the first cookie whose name is exactly "vgnvisitor"
17131 capture cookie vgnvisitor= len 32
17132
17133
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200171348.8. Capturing HTTP headers
17135---------------------------
Willy Tarreaucc6c8912009-02-22 10:53:55 +010017136
17137Header captures are useful to track unique request identifiers set by an upper
17138proxy, virtual host names, user-agents, POST content-length, referrers, etc. In
17139the response, one can search for information about the response length, how the
17140server asked the cache to behave, or an object location during a redirection.
17141
17142Header captures are performed using the "capture request header" and "capture
17143response header" statements in the frontend. Please consult their definition in
Willy Tarreauc57f0e22009-05-10 13:12:33 +020017144section 4.2 for more details.
Willy Tarreaucc6c8912009-02-22 10:53:55 +010017145
17146It is possible to include both request headers and response headers at the same
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +010017147time. Non-existent headers are logged as empty strings, and if one header
17148appears more than once, only its last occurrence will be logged. Request headers
Willy Tarreaucc6c8912009-02-22 10:53:55 +010017149are grouped within braces '{' and '}' in the same order as they were declared,
17150and delimited with a vertical bar '|' without any space. Response headers
17151follow the same representation, but are displayed after a space following the
17152request headers block. These blocks are displayed just before the HTTP request
17153in the logs.
17154
Willy Tarreaud9ed3d22014-06-13 12:23:06 +020017155As a special case, it is possible to specify an HTTP header capture in a TCP
17156frontend. The purpose is to enable logging of headers which will be parsed in
17157an HTTP backend if the request is then switched to this HTTP backend.
17158
Willy Tarreaucc6c8912009-02-22 10:53:55 +010017159 Example :
17160 # This instance chains to the outgoing proxy
17161 listen proxy-out
17162 mode http
17163 option httplog
17164 option logasap
17165 log global
17166 server cache1 192.168.1.1:3128
17167
17168 # log the name of the virtual server
17169 capture request header Host len 20
17170
17171 # log the amount of data uploaded during a POST
17172 capture request header Content-Length len 10
17173
17174 # log the beginning of the referrer
17175 capture request header Referer len 20
17176
17177 # server name (useful for outgoing proxies only)
17178 capture response header Server len 20
17179
17180 # logging the content-length is useful with "option logasap"
17181 capture response header Content-Length len 10
17182
Davor Ocelice9ed2812017-12-25 17:49:28 +010017183 # log the expected cache behavior on the response
Willy Tarreaucc6c8912009-02-22 10:53:55 +010017184 capture response header Cache-Control len 8
17185
17186 # the Via header will report the next proxy's name
17187 capture response header Via len 20
17188
17189 # log the URL location during a redirection
17190 capture response header Location len 20
17191
17192 >>> Aug 9 20:26:09 localhost \
17193 haproxy[2022]: 127.0.0.1:34014 [09/Aug/2004:20:26:09] proxy-out \
17194 proxy-out/cache1 0/0/0/162/+162 200 +350 - - ---- 0/0/0/0/0 0/0 \
17195 {fr.adserver.yahoo.co||http://fr.f416.mail.} {|864|private||} \
17196 "GET http://fr.adserver.yahoo.com/"
17197
17198 >>> Aug 9 20:30:46 localhost \
17199 haproxy[2022]: 127.0.0.1:34020 [09/Aug/2004:20:30:46] proxy-out \
17200 proxy-out/cache1 0/0/0/182/+182 200 +279 - - ---- 0/0/0/0/0 0/0 \
17201 {w.ods.org||} {Formilux/0.1.8|3495|||} \
Willy Tarreaud72758d2010-01-12 10:42:19 +010017202 "GET http://trafic.1wt.eu/ HTTP/1.1"
Willy Tarreaucc6c8912009-02-22 10:53:55 +010017203
17204 >>> Aug 9 20:30:46 localhost \
17205 haproxy[2022]: 127.0.0.1:34028 [09/Aug/2004:20:30:46] proxy-out \
17206 proxy-out/cache1 0/0/2/126/+128 301 +223 - - ---- 0/0/0/0/0 0/0 \
17207 {www.sytadin.equipement.gouv.fr||http://trafic.1wt.eu/} \
17208 {Apache|230|||http://www.sytadin.} \
Willy Tarreaud72758d2010-01-12 10:42:19 +010017209 "GET http://www.sytadin.equipement.gouv.fr/ HTTP/1.1"
Willy Tarreaucc6c8912009-02-22 10:53:55 +010017210
17211
Willy Tarreauc57f0e22009-05-10 13:12:33 +0200172128.9. Examples of logs
17213---------------------
Willy Tarreaucc6c8912009-02-22 10:53:55 +010017214
17215These are real-world examples of logs accompanied with an explanation. Some of
17216them have been made up by hand. The syslog part has been removed for better
17217reading. Their sole purpose is to explain how to decipher them.
17218
17219 >>> haproxy[674]: 127.0.0.1:33318 [15/Oct/2003:08:31:57.130] px-http \
17220 px-http/srv1 6559/0/7/147/6723 200 243 - - ---- 5/3/3/1/0 0/0 \
17221 "HEAD / HTTP/1.0"
17222
17223 => long request (6.5s) entered by hand through 'telnet'. The server replied
17224 in 147 ms, and the session ended normally ('----')
17225
17226 >>> haproxy[674]: 127.0.0.1:33319 [15/Oct/2003:08:31:57.149] px-http \
17227 px-http/srv1 6559/1230/7/147/6870 200 243 - - ---- 324/239/239/99/0 \
17228 0/9 "HEAD / HTTP/1.0"
17229
17230 => Idem, but the request was queued in the global queue behind 9 other
17231 requests, and waited there for 1230 ms.
17232
17233 >>> haproxy[674]: 127.0.0.1:33320 [15/Oct/2003:08:32:17.654] px-http \
17234 px-http/srv1 9/0/7/14/+30 200 +243 - - ---- 3/3/3/1/0 0/0 \
17235 "GET /image.iso HTTP/1.0"
17236
17237 => request for a long data transfer. The "logasap" option was specified, so
Krzysztof Piotr Oledzkif8645332009-12-13 21:55:50 +010017238 the log was produced just before transferring data. The server replied in
Willy Tarreaucc6c8912009-02-22 10:53:55 +010017239 14 ms, 243 bytes of headers were sent to the client, and total time from
17240 accept to first data byte is 30 ms.
17241
17242 >>> haproxy[674]: 127.0.0.1:33320 [15/Oct/2003:08:32:17.925] px-http \
17243 px-http/srv1 9/0/7/14/30 502 243 - - PH-- 3/2/2/0/0 0/0 \
17244 "GET /cgi-bin/bug.cgi? HTTP/1.0"
17245
17246 => the proxy blocked a server response either because of an "rspdeny" or
17247 "rspideny" filter, or because the response was improperly formatted and
Willy Tarreau3c92c5f2011-08-28 09:45:47 +020017248 not HTTP-compliant, or because it blocked sensitive information which
Willy Tarreaucc6c8912009-02-22 10:53:55 +010017249 risked being cached. In this case, the response is replaced with a "502
17250 bad gateway". The flags ("PH--") tell us that it was haproxy who decided
17251 to return the 502 and not the server.
17252
17253 >>> haproxy[18113]: 127.0.0.1:34548 [15/Oct/2003:15:18:55.798] px-http \
Willy Tarreaud72758d2010-01-12 10:42:19 +010017254 px-http/<NOSRV> -1/-1/-1/-1/8490 -1 0 - - CR-- 2/2/2/0/0 0/0 ""
Willy Tarreaucc6c8912009-02-22 10:53:55 +010017255
17256 => the client never completed its request and aborted itself ("C---") after
17257 8.5s, while the proxy was waiting for the request headers ("-R--").
17258 Nothing was sent to any server.
17259
17260 >>> haproxy[18113]: 127.0.0.1:34549 [15/Oct/2003:15:19:06.103] px-http \
17261 px-http/<NOSRV> -1/-1/-1/-1/50001 408 0 - - cR-- 2/2/2/0/0 0/0 ""
17262
17263 => The client never completed its request, which was aborted by the
17264 time-out ("c---") after 50s, while the proxy was waiting for the request
Davor Ocelice9ed2812017-12-25 17:49:28 +010017265 headers ("-R--"). Nothing was sent to any server, but the proxy could
Willy Tarreaucc6c8912009-02-22 10:53:55 +010017266 send a 408 return code to the client.
17267
17268 >>> haproxy[18989]: 127.0.0.1:34550 [15/Oct/2003:15:24:28.312] px-tcp \
17269 px-tcp/srv1 0/0/5007 0 cD 0/0/0/0/0 0/0
17270
17271 => This log was produced with "option tcplog". The client timed out after
17272 5 seconds ("c----").
17273
17274 >>> haproxy[18989]: 10.0.0.1:34552 [15/Oct/2003:15:26:31.462] px-http \
17275 px-http/srv1 3183/-1/-1/-1/11215 503 0 - - SC-- 205/202/202/115/3 \
Willy Tarreaud72758d2010-01-12 10:42:19 +010017276 0/0 "HEAD / HTTP/1.0"
Willy Tarreaucc6c8912009-02-22 10:53:55 +010017277
17278 => The request took 3s to complete (probably a network problem), and the
Willy Tarreauc57f0e22009-05-10 13:12:33 +020017279 connection to the server failed ('SC--') after 4 attempts of 2 seconds
Willy Tarreaucc6c8912009-02-22 10:53:55 +010017280 (config says 'retries 3'), and no redispatch (otherwise we would have
17281 seen "/+3"). Status code 503 was returned to the client. There were 115
17282 connections on this server, 202 connections on this proxy, and 205 on
17283 the global process. It is possible that the server refused the
17284 connection because of too many already established.
Willy Tarreau844e3c52008-01-11 16:28:18 +010017285
Willy Tarreau52b2d222011-09-07 23:48:48 +020017286
Christopher Fauletc3fe5332016-04-07 15:30:10 +0200172879. Supported filters
17288--------------------
17289
17290Here are listed officially supported filters with the list of parameters they
17291accept. Depending on compile options, some of these filters might be
17292unavailable. The list of available filters is reported in haproxy -vv.
17293
17294See also : "filter"
17295
172969.1. Trace
17297----------
17298
Christopher Faulet31bfe1f2016-12-09 17:42:38 +010017299filter trace [name <name>] [random-parsing] [random-forwarding] [hexdump]
Christopher Fauletc3fe5332016-04-07 15:30:10 +020017300
17301 Arguments:
17302 <name> is an arbitrary name that will be reported in
17303 messages. If no name is provided, "TRACE" is used.
17304
17305 <random-parsing> enables the random parsing of data exchanged between
17306 the client and the server. By default, this filter
17307 parses all available data. With this parameter, it
17308 only parses a random amount of the available data.
17309
Davor Ocelice9ed2812017-12-25 17:49:28 +010017310 <random-forwarding> enables the random forwarding of parsed data. By
Christopher Fauletc3fe5332016-04-07 15:30:10 +020017311 default, this filter forwards all previously parsed
17312 data. With this parameter, it only forwards a random
17313 amount of the parsed data.
17314
Davor Ocelice9ed2812017-12-25 17:49:28 +010017315 <hexdump> dumps all forwarded data to the server and the client.
Christopher Faulet31bfe1f2016-12-09 17:42:38 +010017316
Christopher Fauletc3fe5332016-04-07 15:30:10 +020017317This filter can be used as a base to develop new filters. It defines all
17318callbacks and print a message on the standard error stream (stderr) with useful
17319information for all of them. It may be useful to debug the activity of other
17320filters or, quite simply, HAProxy's activity.
17321
17322Using <random-parsing> and/or <random-forwarding> parameters is a good way to
17323tests the behavior of a filter that parses data exchanged between a client and
17324a server by adding some latencies in the processing.
17325
17326
173279.2. HTTP compression
17328---------------------
17329
17330filter compression
17331
17332The HTTP compression has been moved in a filter in HAProxy 1.7. "compression"
17333keyword must still be used to enable and configure the HTTP compression. And
17334when no other filter is used, it is enough. But it is mandatory to explicitly
17335use a filter line to enable the HTTP compression when two or more filters are
17336used for the same listener/frontend/backend. This is important to know the
17337filters evaluation order.
17338
17339See also : "compression"
17340
17341
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200173429.3. Stream Processing Offload Engine (SPOE)
17343--------------------------------------------
17344
17345filter spoe [engine <name>] config <file>
17346
17347 Arguments :
17348
17349 <name> is the engine name that will be used to find the right scope in
17350 the configuration file. If not provided, all the file will be
17351 parsed.
17352
17353 <file> is the path of the engine configuration file. This file can
17354 contain configuration of several engines. In this case, each
17355 part must be placed in its own scope.
17356
17357The Stream Processing Offload Engine (SPOE) is a filter communicating with
17358external components. It allows the offload of some specifics processing on the
Davor Ocelice9ed2812017-12-25 17:49:28 +010017359streams in tiered applications. These external components and information
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +020017360exchanged with them are configured in dedicated files, for the main part. It
17361also requires dedicated backends, defined in HAProxy configuration.
17362
17363SPOE communicates with external components using an in-house binary protocol,
17364the Stream Processing Offload Protocol (SPOP).
17365
Tim Düsterhus4896c442016-11-29 02:15:19 +010017366For all information about the SPOE configuration and the SPOP specification, see
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +020017367"doc/SPOE.txt".
17368
17369Important note:
17370 The SPOE filter is highly experimental for now and was not heavily
17371 tested. It is really not production ready. So use it carefully.
17372
William Lallemand86d0df02017-11-24 21:36:45 +01001737310. Cache
17374---------
17375
17376HAProxy provides a cache, which was designed to perform cache on small objects
17377(favicon, css...). This is a minimalist low-maintenance cache which runs in
17378RAM.
17379
17380The cache is based on a memory which is shared between processes and threads,
Cyril Bonté7b888f12017-11-26 22:24:31 +010017381this memory is split in blocks of 1k.
William Lallemand86d0df02017-11-24 21:36:45 +010017382
17383If an object is not used anymore, it can be deleted to store a new object
17384independently of its expiration date. The oldest objects are deleted first
17385when we try to allocate a new one.
17386
Cyril Bonté7b888f12017-11-26 22:24:31 +010017387The cache uses a hash of the host header and the URI as the key.
William Lallemand86d0df02017-11-24 21:36:45 +010017388
17389It's possible to view the status of a cache using the Unix socket command
17390"show cache" consult section 9.3 "Unix Socket commands" of Management Guide
17391for more details.
17392
17393When an object is delivered from the cache, the server name in the log is
17394replaced by "<CACHE>".
17395
Cyril Bonté7b888f12017-11-26 22:24:31 +01001739610.1. Limitation
17397----------------
William Lallemand86d0df02017-11-24 21:36:45 +010017398
17399The cache won't store and won't deliver objects in these cases:
17400
17401- If the response is not a 200
17402- If the response contains a Vary header
17403- If the response does not contain a Content-Length header or if the
17404 Content-Length + the headers size is greater than a buffer size - the
17405 reserve.
17406- If the response is not cacheable
17407
17408- If the request is not a GET
17409- If the HTTP version of the request is smaller than 1.1
William Lallemand8a16fe02018-05-22 11:04:33 +020017410- If the request contains an Authorization header
William Lallemand86d0df02017-11-24 21:36:45 +010017411
17412Caution!: Due to the current limitation of the filters, it is not recommended
17413to use the cache with other filters. Using them can cause undefined behavior
Cyril Bonté7b888f12017-11-26 22:24:31 +010017414if they modify the response (compression for example).
William Lallemand86d0df02017-11-24 21:36:45 +010017415
Cyril Bonté7b888f12017-11-26 22:24:31 +01001741610.2. Setup
17417-----------
William Lallemand86d0df02017-11-24 21:36:45 +010017418
17419To setup a cache, you must define a cache section and use it in a proxy with
17420the corresponding http-request and response actions.
17421
Cyril Bonté7b888f12017-11-26 22:24:31 +01001742210.2.1. Cache section
17423---------------------
William Lallemand86d0df02017-11-24 21:36:45 +010017424
17425cache <name>
17426 Declare a cache section, allocate a shared cache memory named <name>, the
17427 size of cache is mandatory.
17428
17429total-max-size <megabytes>
Davor Ocelice9ed2812017-12-25 17:49:28 +010017430 Define the size in RAM of the cache in megabytes. This size is split in
17431 blocks of 1kB which are used by the cache entries.
William Lallemand86d0df02017-11-24 21:36:45 +010017432
17433max-age <seconds>
17434 Define the maximum expiration duration. The expiration is set has the lowest
17435 value between the s-maxage or max-age (in this order) directive in the
17436 Cache-Control response header and this value. The default value is 60
17437 seconds, which means that you can't cache an object more than 60 seconds by
17438 default.
17439
Cyril Bonté7b888f12017-11-26 22:24:31 +01001744010.2.2. Proxy section
17441---------------------
William Lallemand86d0df02017-11-24 21:36:45 +010017442
17443http-request cache-use <name>
17444 Try to deliver a cached object from the cache <name>. This directive is also
17445 mandatory to store the cache as it calculates the cache hash. If you want to
17446 use a condition for both storage and delivering that's a good idea to put it
17447 after this one.
17448
17449http-response cache-store <name>
17450 Store an http-response within the cache. The storage of the response headers
17451 is done at this step, which means you can use others http-response actions
17452 to modify headers before or after the storage of the response. This action
17453 is responsible for the setup of the cache storage filter.
17454
17455
17456Example:
17457
17458 backend bck1
17459 mode http
17460
17461 http-request cache-use foobar
17462 http-response cache-store foobar
17463 server srv1 127.0.0.1:80
17464
17465 cache foobar
17466 total-max-size 4
17467 max-age 240
17468
Willy Tarreau0ba27502007-12-24 16:55:16 +010017469/*
17470 * Local variables:
17471 * fill-column: 79
17472 * End:
17473 */