blob: fd4dc1a17532b84d75bb2c205d1162bb9114812a [file] [log] [blame]
willy tarreau0174f312005-12-18 01:02:42 +01001 -------------------
Willy Tarreau94b45912006-05-31 06:40:15 +02002 HAProxy
willy tarreau0174f312005-12-18 01:02:42 +01003 Manuel de référence
4 -------------------
willy tarreau7e6328d2006-05-21 23:26:20 +02005 version 1.2.14
willy tarreauc5f73ed2005-12-18 01:26:38 +01006 willy tarreau
willy tarreau7e6328d2006-05-21 23:26:20 +02007 2006/05/21
willy tarreau0f7af912005-12-17 12:21:26 +01008
willy tarreaub719f002005-12-17 12:55:07 +01009================
10| Introduction |
11================
willy tarreau0f7af912005-12-17 12:21:26 +010012
Willy Tarreau94b45912006-05-31 06:40:15 +020013HAProxy est un relais TCP/HTTP offrant des facilités d'intégration en
willy tarreau0f7af912005-12-17 12:21:26 +010014environnement hautement disponible. En effet, il est capable de :
willy tarreauc29948c2005-12-17 13:10:27 +010015 - effectuer un aiguillage statique défini par des cookies ;
willy tarreau64a3cc32005-12-18 01:13:11 +010016 - effectuer une répartition de charge avec création de cookies pour assurer
17 la persistence de session ;
willy tarreau0f7af912005-12-17 12:21:26 +010018 - fournir une visibilité externe de son état de santé ;
willy tarreau8337c6b2005-12-17 13:41:01 +010019 - s'arrêter en douceur sans perte brutale de service ;
willy tarreauc5f73ed2005-12-18 01:26:38 +010020 - modifier/ajouter/supprimer des en-têtes dans la requête et la réponse ;
willy tarreau8337c6b2005-12-17 13:41:01 +010021 - interdire des requêtes qui vérifient certaines conditions ;
22 - utiliser des serveurs de secours lorsque les serveurs principaux sont hors
23 d'usage.
willy tarreau532bb552006-05-13 18:40:37 +020024 - maintenir des clients sur le bon serveur serveur d'application en fonction
25 de cookies applicatifs.
willy tarreau8f635a42006-05-21 23:05:54 +020026 - fournir des rapports d'état en HTML à des utilisateurs authentifiés, à
27 travers des URI de l'application interceptées.
willy tarreau0f7af912005-12-17 12:21:26 +010028
willy tarreau64a3cc32005-12-18 01:13:11 +010029Il requiert peu de ressources, et son architecture événementielle mono-
30processus lui permet facilement de gérer plusieurs milliers de connexions
31simultanées sur plusieurs relais sans effondrer le système.
willy tarreaua1598082005-12-17 13:08:06 +010032
willy tarreau0f7af912005-12-17 12:21:26 +010033
34===========================
35| Paramètres de lancement |
36===========================
37
38Les options de lancement sont peu nombreuses :
39
40 -f <fichier de configuration>
41 -n <nombre maximal total de connexions simultanées>
willy tarreau532bb552006-05-13 18:40:37 +020042 = 'maxconn' dans la section 'global'
43 -N <nombre maximal de connexions simultanées par instance>
44 = 'maxconn' dans les sections 'listen' ou 'default'
willy tarreau0f7af912005-12-17 12:21:26 +010045 -d active le mode debug
46 -D passe en daemon
willy tarreau982249e2005-12-18 00:57:06 +010047 -q désactive l'affichage de messages sur la sortie standard.
48 -V affiche les messages sur la sortie standard, même si -q ou 'quiet' sont
49 spécifiés.
50 -c vérifie le fichier de configuration puis quitte avec un code de retour 0
51 si aucune erreur n'a été trouvée, ou 1 si une erreur de syntaxe a été
52 détectée.
willy tarreaufe2c5c12005-12-17 14:14:34 +010053 -p <fichier> indique au processus père qu'il doit écrire les PIDs de ses
54 fils dans ce fichier en mode démon.
willy tarreau34f45302006-04-15 21:37:14 +020055 -sf specifie une liste de PIDs auxquels envoyer un signal FINISH
56 -st specifie une liste de PIDs auxquels envoyer un signal TERMINATE
willy tarreau0f7af912005-12-17 12:21:26 +010057 -s affiche les statistiques (si option compilée)
58 -l ajoute des informations aux statistiques
willy tarreau64a3cc32005-12-18 01:13:11 +010059 -de désactive l'utilisation de epoll()
60 -dp désactive l'utilisation de poll()
willy tarreau34f45302006-04-15 21:37:14 +020061 -db désactive la mise en arrière-plan (utile pour débugger)
62 -m <megs> applique une limitation de <megs> Mo d'utilisation mémoire
willy tarreau0f7af912005-12-17 12:21:26 +010063
willy tarreau64a3cc32005-12-18 01:13:11 +010064Le nombre maximal de connexion simultanées par proxy est le paramètre par
65défaut pour les proxies pour lesquels ce paramètre n'est pas précisé dans le
66fichier de configuration. Il s'agit du paramètre 'maxconn' dans les sections
67'listen'.
willy tarreau0f7af912005-12-17 12:21:26 +010068
willy tarreau64a3cc32005-12-18 01:13:11 +010069Le nombre maximal total de connexions simultanées limite le nombre de
70connexions TCP utilisables à un instant donné par le processus, tous proxies
71confondus. Ce paramètre remplace le paramètre 'maxconn' de la section 'global'.
willy tarreaua1598082005-12-17 13:08:06 +010072
willy tarreauc29948c2005-12-17 13:10:27 +010073Le mode debug correspond à l'option 'debug' de la section 'global'. Dans ce
willy tarreauc5f73ed2005-12-18 01:26:38 +010074mode, toutes les connexions, déconnexions, et tous les échanges d'en-têtes HTTP
willy tarreauc29948c2005-12-17 13:10:27 +010075sont affichés.
76
willy tarreau34f45302006-04-15 21:37:14 +020077Pour debugger, l'option '-db' est très pratique car elle désactive
78temporairement le mode daemon et le mode multi-processus. Le service peut alors
79être arrêté par un simple appui sur Ctrl-C, sans avoir à modifier la
80configuration ni à activer le mode debug complet.
81
willy tarreauc29948c2005-12-17 13:10:27 +010082Les statistiques ne sont disponibles que si le programme a été compilé avec
83l'option "STATTIME". Il s'agit principalement de données brutes n'ayant
willy tarreau8f635a42006-05-21 23:05:54 +020084d'utilité que lors de benchmarks par exemple, et sont amenées à disparaitre.
willy tarreauc29948c2005-12-17 13:10:27 +010085
willy tarreau532bb552006-05-13 18:40:37 +020086Les paramètres '-st' et '-sf' sont utilisés pour la reconfiguration à chaud.
87Voir la section à ce sujet.
willy tarreau0f7af912005-12-17 12:21:26 +010088
89============================
90| Fichier de configuration |
91============================
92
willy tarreauc29948c2005-12-17 13:10:27 +010093Structure
94=========
willy tarreau0f7af912005-12-17 12:21:26 +010095
willy tarreaua1598082005-12-17 13:08:06 +010096L'analyseur du fichier de configuration ignore des lignes vides, les espaces,
willy tarreau64a3cc32005-12-18 01:13:11 +010097les tabulations, et tout ce qui est compris entre le symbole '#' (s'il n'est
98pas précédé d'un '\'), et la fin de la ligne, ce qui constitue un commentaire.
willy tarreaua1598082005-12-17 13:08:06 +010099
100Le fichier de configuration est découpé en sections répérées par des mots clés
101tels que :
102
103 - 'global'
104 - 'listen'
willy tarreaua41a8b42005-12-17 14:02:24 +0100105 - 'defaults'
willy tarreaua1598082005-12-17 13:08:06 +0100106
107Tous les paramètres font référence à la section définie par le dernier mot clé
108reconnu.
109
110
willy tarreauc29948c2005-12-17 13:10:27 +01001111) Paramètres globaux
112=====================
willy tarreaua1598082005-12-17 13:08:06 +0100113
114Il s'agit des paramètres agissant sur le processus, ou bien sur l'ensemble des
115proxies. Ils sont tous spécifiés dans la section 'global'. Les paramètres
116supportés sont :
117
willy tarreau8337c6b2005-12-17 13:41:01 +0100118 - log <adresse> <catégorie> [niveau_max]
willy tarreaua1598082005-12-17 13:08:06 +0100119 - maxconn <nombre>
120 - uid <identifiant>
121 - gid <identifiant>
122 - chroot <répertoire>
123 - nbproc <nombre>
124 - daemon
125 - debug
willy tarreau64a3cc32005-12-18 01:13:11 +0100126 - noepoll
127 - nopoll
willy tarreaua1598082005-12-17 13:08:06 +0100128 - quiet
willy tarreaufe2c5c12005-12-17 14:14:34 +0100129 - pidfile <fichier>
willy tarreauc5f73ed2005-12-18 01:26:38 +0100130 - ulimit-n <nombre>
131
willy tarreaua1598082005-12-17 13:08:06 +0100132
1331.1) Journalisation des événements
134----------------------------------
135La plupart des événements sont journalisés : démarrages, arrêts, disparition et
136apparition de serveurs, connexions, erreurs. Tous les messages sont envoyés en
137syslog vers un ou deux serveurs. La syntaxe est la suivante :
138
willy tarreau8337c6b2005-12-17 13:41:01 +0100139 log <adresse_ip> <catégorie> [niveau_max]
willy tarreaua1598082005-12-17 13:08:06 +0100140
141Les connexions sont envoyées en niveau "info". Les démarrages de service et de
142serveurs seront envoyés en "notice", les signaux d'arrêts en "warning" et les
143arrêts définitifs de services et de serveurs en "alert". Ceci est valable aussi
willy tarreau64a3cc32005-12-18 01:13:11 +0100144bien pour les proxies que pour les serveurs testés par les proxies. Le
145paramètre optionnel <niveau_max> définit le niveau maximal de traces émises
146parmi les 8 valeurs suivantes :
willy tarreau8337c6b2005-12-17 13:41:01 +0100147 emerg, alert, crit, err, warning, notice, info, debug
148
willy tarreaueedaa9f2005-12-17 14:08:03 +0100149Par compatibilité avec les versions 1.1.16 et antérieures, la valeur par défaut
willy tarreau8337c6b2005-12-17 13:41:01 +0100150est "debug" si l'option n'est pas précisée.
willy tarreaua1598082005-12-17 13:08:06 +0100151
152Les catégories possibles sont :
153 kern, user, mail, daemon, auth, syslog, lpr, news,
154 uucp, cron, auth2, ftp, ntp, audit, alert, cron2,
155 local0, local1, local2, local3, local4, local5, local6, local7
156
willy tarreau036e1ce2005-12-17 13:46:33 +0100157Conformément à la RFC3164, les messages émis sont limités à 1024 caractères.
158
willy tarreaua1598082005-12-17 13:08:06 +0100159Exemple :
160---------
161 global
willy tarreauc5f73ed2005-12-18 01:26:38 +0100162 log 192.168.2.200 local3
163 log 127.0.0.1 local4 notice
willy tarreaua1598082005-12-17 13:08:06 +0100164
1651.2) limitation du nombre de connexions
166---------------------------------------
167Il est possible et conseillé de limiter le nombre global de connexions par
willy tarreauc5f73ed2005-12-18 01:26:38 +0100168processus à l'aide du mot clé global 'maxconn'. Les connexions sont comprises
169au sens 'acceptation de connexion', donc il faut s'attendre en règle général à
170avoir un peu plus du double de sessions TCP que le maximum de connexions fixé.
171C'est important pour fixer le paramètre 'ulimit -n' avant de lancer le proxy.
172Pour comptabiliser le nombre de sockets nécessaires, il faut prendre en compte
173ces paramètres :
174
willy tarreaua1598082005-12-17 13:08:06 +0100175 - 1 socket par connexion entrante
176 - 1 socket par connexion sortante
willy tarreaueedaa9f2005-12-17 14:08:03 +0100177 - 1 socket par couple adresse/port d'écoute par proxy
willy tarreaua1598082005-12-17 13:08:06 +0100178 - 1 socket pour chaque serveur en cours de health-check
willy tarreauc29948c2005-12-17 13:10:27 +0100179 - 1 socket pour les logs (tous serveurs confondus)
willy tarreaua1598082005-12-17 13:08:06 +0100180
willy tarreau64a3cc32005-12-18 01:13:11 +0100181Dans le cas où chaque proxy n'écoute que sur un couple adresse/port,
willy tarreauc5f73ed2005-12-18 01:26:38 +0100182positionner la limite du nombre de descripteurs de fichiers (ulimit -n) à
183(2 * maxconn + nbproxy + nbserveurs + 1). A partir des versions 1.1.32/1.2.6,
184il est possible de spécifier cette limite dans la configuration à l'aide du
185mot-clé global 'ulimit-n', à condition bien entendu que le proxy ait été
186démarré sous le compte root (ou avec des droits suffisants pour élever le
187nombre de descripteurs de fichiers). Cette solution met un terme au problème
188récurrent d'incertitude de l'adéquation entre les limites systèmes lors de la
189dernière relance du proxessus et les limites en nombre de connexions. Noter que
190cette limite s'applique par processus.
191
192Exemple :
193---------
194 global
195 maxconn 32000
196 ulimit-n 65536
197
willy tarreauc29948c2005-12-17 13:10:27 +0100198
1991.3) Diminution des privilèges
200------------------------------
201Afin de réduire les risques d'attaques dans le cas où une faille non identifiée
202serait exploitée, il est possible de diminuer les privilèges du processus, et
willy tarreau8337c6b2005-12-17 13:41:01 +0100203de l'isoler dans un répertoire sans risque.
willy tarreaua1598082005-12-17 13:08:06 +0100204
willy tarreauc29948c2005-12-17 13:10:27 +0100205Dans la section 'global', le paramètre 'uid' permet de spécifier un identifiant
206numérique d'utilisateur. La valeur 0, correspondant normalement au super-
207utilisateur, possède ici une signification particulière car elle indique que
208l'on ne souhaite pas changer cet identifiant et conserver la valeur courante.
209C'est la valeur par défaut. De la même manière, le paramètre 'gid' correspond à
210un identifiant de groupe, et utilise par défaut la valeur 0 pour ne rien
211changer. Il est particulièrement déconseillé d'utiliser des comptes génériques
212tels que 'nobody' car cette pratique revient à utiliser 'root' si d'autres
213processus utilisent les mêmes identifiants.
214
215Le paramètre 'chroot' autorise à changer la racine du processus une fois le
216programme lancé, de sorte que ni le processus, ni l'un de ses descendants ne
willy tarreau8337c6b2005-12-17 13:41:01 +0100217puissent remonter de nouveau à la racine. Ce type de cloisonnement (chroot) est
willy tarreaueedaa9f2005-12-17 14:08:03 +0100218généralement contournable sur certains OS (Linux, Solaris) pour peu que
219l'attaquant possède des droits 'root' et soit en mesure d'utiliser ou de créer
220un répertoire. Aussi, il est important d'utiliser un répertoire spécifique au
221service pour cet usage, et de ne pas mutualiser un même répertoire pour
222plusieurs services de nature différente. Pour rendre l'isolement plus robuste,
223il est conseillé d'utiliser un répertoire vide, sans aucun droit, et de changer
224l'uid du processus de sorte qu'il ne puisse rien faire dans ledit répertoire.
willy tarreauc29948c2005-12-17 13:10:27 +0100225
willy tarreau64a3cc32005-12-18 01:13:11 +0100226Remarque importante :
227---------------------
228Dans le cas où une telle faille serait mise en évidence, il est fort probable
229que les premières tentatives de son exploitation provoquent un arrêt du
willy tarreauc29948c2005-12-17 13:10:27 +0100230programme, à cause d'un signal de type 'Segmentation Fault', 'Bus Error' ou
willy tarreau64a3cc32005-12-18 01:13:11 +0100231encore 'Illegal Instruction'. Même s'il est vrai que faire tourner le serveur
232en environnement limité réduit les risques d'intrusion, il est parfois bien
233utile dans ces circonstances de connaître les conditions d'apparition du
234problème, via l'obtention d'un fichier 'core'. La plupart des systèmes, pour
235des raisons de sécurité, désactivent la génération du fichier 'core' après un
236changement d'identifiant pour le processus. Il faudra donc soit lancer le
237processus à partir d'un compte utilisateur aux droits réduits (mais ne pouvant
238pas effectuer le chroot), ou bien le faire en root sans réduction des droits
239(uid 0). Dans ce cas, le fichier se trouvera soit dans le répertoire de
240lancement, soit dans le répertoire spécifié après l'option 'chroot'. Ne pas
241oublier la commande suivante pour autoriser la génération du fichier avant de
242lancer le programme :
willy tarreauc29948c2005-12-17 13:10:27 +0100243
244# ulimit -c unlimited
willy tarreaua1598082005-12-17 13:08:06 +0100245
willy tarreauc29948c2005-12-17 13:10:27 +0100246Exemple :
247---------
248
249 global
willy tarreauc5f73ed2005-12-18 01:26:38 +0100250 uid 30000
251 gid 30000
252 chroot /var/chroot/haproxy
willy tarreauc29948c2005-12-17 13:10:27 +0100253
willy tarreaufe2c5c12005-12-17 14:14:34 +01002541.4) Modes de fonctionnement
willy tarreauc29948c2005-12-17 13:10:27 +0100255----------------------------
256Le service peut fonctionner dans plusieurs modes :
257 - avant- / arrière-plan
258 - silencieux / normal / debug
willy tarreau0f7af912005-12-17 12:21:26 +0100259
willy tarreau64a3cc32005-12-18 01:13:11 +0100260Le mode par défaut est normal, avant-plan, c'est à dire que le programme ne
261rend pas la main une fois lancé. Il ne faut surtout pas le lancer comme ceci
262dans un script de démarrage du système, sinon le système ne finirait pas son
willy tarreauc29948c2005-12-17 13:10:27 +0100263initialisation. Il faut le mettre en arrière-plan, de sorte qu'il rende la main
264au processus appelant. C'est ce que fait l'option 'daemon' de la section
265'global', et qui est l'équivalent du paramètre '-D' de la ligne de commande.
willy tarreau0f7af912005-12-17 12:21:26 +0100266
willy tarreau34f45302006-04-15 21:37:14 +0200267Le paramètre de ligne de commande '-db' inhibe les options globales 'daemon'
268et 'nbproc' pour faire fonctionner le processus en mode normal, avant-plan.
269
willy tarreauc29948c2005-12-17 13:10:27 +0100270Par ailleurs, certains messages d'alerte sont toujours envoyés sur la sortie
271standard, même en mode 'daemon'. Pour ne plus les voir ailleurs que dans les
272logs, il suffit de passer en mode silencieux par l'ajout de l'option 'quiet'.
273Cette option n'a pas d'équivalent en ligne de commande.
willy tarreau0f7af912005-12-17 12:21:26 +0100274
willy tarreauc29948c2005-12-17 13:10:27 +0100275Enfin, le mode 'debug' permet de diagnostiquer les origines de certains
276problèmes en affichant les connexions, déconnexions et échanges d'en-têtes HTTP
277entre les clients et les serveurs. Ce mode est incompatible avec les options
278'daemon' et 'quiet' pour des raisons de bon sens.
279
willy tarreaufe2c5c12005-12-17 14:14:34 +01002801.5) Accroissement de la capacité de traitement
willy tarreauc29948c2005-12-17 13:10:27 +0100281-----------------------------------------------
282Sur des machines multi-processeurs, il peut sembler gâché de n'utiliser qu'un
283processeur pour effectuer les tâches de relayage, même si les charges
284nécessaires à saturer un processeur actuel sont bien au-delà des ordres de
285grandeur couramment rencontrés. Cependant, pour des besoins particuliers, le
286programme sait démarrer plusieurs processus se répartissant la charge de
287travail. Ce nombre de processus est spécifié par le paramètre 'nbproc' de la
288section 'global'. Sa valeur par défaut est naturellement 1. Ceci ne fonctionne
willy tarreau4302f492005-12-18 01:00:37 +0100289qu'en mode 'daemon'. Un usage déjà rencontré pour ce paramètre fut de dépasser
290la limite de nombre de descripteurs de fichiers allouée par processus sous
291Solaris.
willy tarreauc29948c2005-12-17 13:10:27 +0100292
293Exemple :
294---------
295
296 global
willy tarreauc5f73ed2005-12-18 01:26:38 +0100297 daemon
298 quiet
299 nbproc 2
willy tarreauc29948c2005-12-17 13:10:27 +0100300
willy tarreaufe2c5c12005-12-17 14:14:34 +01003011.6) Simplification de la gestion des processus
302-----------------------------------------------
303Haproxy supporte dorénavant la notion de fichiers de pid (-> pidfiles). Si le
304paramètre '-p' de ligne de commande, ou l'option globale 'pidfile' sont suivis
305d'un nom de fichier, alors ce fichier sera supprimé puis recréé et contiendra
306le numéro de PID des processus fils, à raison d'un par ligne (valable
307uniquement en mode démon). Ce fichier n'est PAS relatif au cloisonnement chroot
308afin de rester compatible avec un répertoire protégé en lecture seule. Il
309appartiendra à l'utilisateur ayant lancé le processus, et disposera des droits
3100644.
311
312Exemple :
313---------
314
315 global
316 daemon
317 quiet
318 nbproc 2
319 pidfile /var/run/haproxy-private.pid
320
321 # pour stopper seulement ces processus parmi d'autres :
322 # kill $(</var/run/haproxy-private.pid)
323
willy tarreau34f45302006-04-15 21:37:14 +0200324 # pour recharger une configuration avec un impact minimal sur le service,
325 # et sans casser les sessions existantes :
326 # haproxy -f haproxy.cfg -p $(</var/run/haproxy-private.pid) -st $(</var/run/haproxy-private.pid)
willy tarreauc29948c2005-12-17 13:10:27 +0100327
willy tarreau64a3cc32005-12-18 01:13:11 +01003281.7) Mécanismes de traitements des événements
329---------------------------------------------
330A partir de la version 1.2.5, haproxy supporte les mécanismes poll() et
331epoll(). Sur les systems où select() est limité par FD_SETSIZE (comme Solaris),
332poll() peut être une alternative intéressante. Des tests de performance
333montrent que les performances de poll() ne décroissent pas aussi vite que le
334nombre de sockets augmente, ce qui en fait une solution sûre pour les fortes
335charges. Cela dit, Soalris utilise déjà poll() pour émuler select(), donc tant
336que le nombre de sockets ne dépasse pas FD_SETSIZE, poll() ne devrait pas
337apporter de performances supplémentaires. Sur les systèmes à base Linux
338incluant le patch epoll() (ou tous les Linux 2.6), haproxy utilisera epoll()
339qui est extrèmement rapide indépendamment du nombre de sockets. Les tests sur
340haproxy ont montré une performance constante de 1 à 40000 sessions simultanées.
341
342Haproxy utilisera epoll() lorsqu'il est disponible, et se repliera sur poll(),
343puis en dernier lieu sur select(). Cependant, si pour une raison quelconque il
344s'avérait nécessaire de désactiver epoll() ou poll() (p.ex: à cause d'un bug ou
345juste pour comparer les performances), deux nouvelles options globales ont été
346ajoutées dans ce but : 'noepoll' et 'nopoll'.
347
348Exemple :
349---------
350 global
351 # utiliser seulement select()
352 noepoll
353 nopoll
354
355Remarque :
356----------
357Dans le but d'assurer une portabilité maximale des configurations, ces options
358sont acceptées et ignorées si les mécanismes poll() ou epoll() n'ont pas été
359activés lors de la compilation.
360
361Afin de simplifier la résolution de problèmes, le paramètre '-de' en ligne de
362commande désactive epoll() et le paramètre '-dp' désactive poll(). Ils sont
363respectivement équivalents à 'noepoll' et 'nopoll'.
364
365
willy tarreauc29948c2005-12-17 13:10:27 +01003662) Définition d'un service en écoute
367====================================
368
369Les sections de service débutent par le mot clé "listen" :
willy tarreau0f7af912005-12-17 12:21:26 +0100370
willy tarreaua41a8b42005-12-17 14:02:24 +0100371 listen <nom_instance> [ <adresse_IP>:<plage_ports>[,...] ]
willy tarreau0f7af912005-12-17 12:21:26 +0100372
willy tarreauc29948c2005-12-17 13:10:27 +0100373- <nom_instance> est le nom de l'instance décrite. Ce nom sera envoyé dans les
willy tarreau64a3cc32005-12-18 01:13:11 +0100374 logs, donc il est souhaitable d'utiliser un nom relatif au service relayé.
375 Aucun test n'est effectué concernant l'unicité de ce nom, qui n'est pas
376 obligatoire, mais fortement recommandée.
willy tarreau0f7af912005-12-17 12:21:26 +0100377
willy tarreaua41a8b42005-12-17 14:02:24 +0100378- <adresse_IP> est l'adresse IP sur laquelle le relais attend ses connexions.
379 L'absence d'adresse ainsi que l'adresse 0.0.0.0 signifient que les connexions
380 pourront s'effectuer sur toutes les adresses de la machine.
willy tarreau0f7af912005-12-17 12:21:26 +0100381
willy tarreaua41a8b42005-12-17 14:02:24 +0100382- <plage_ports> correspond soit à un port, soit à une plage de ports sur
383 lesquels le relais acceptera des connexions pour l'adresse IP spécifiée.
384 Cette plage peut être :
385 - soit un port numérique (ex: '80')
386 - soit une plage constituée de deux valeurs séparées par un tiret
387 (ex: '2000-2100') représentant les extrémités incluses dans la
388 plage.
389 Il faut faire attention à l'usage des plages, car chaque combinaison
390 <adresse_IP>:<port> consomme une socket, donc un descripteur de fichier.
391 Le couple <adresse_IP>:<port> doit être unique pour toutes les instances
392 d'une même machine. L'attachement à un port inférieur à 1024 nécessite un
willy tarreau64a3cc32005-12-18 01:13:11 +0100393 niveau de privilège particulier lors du lancement du programme
394 (indépendamment du paramètre 'uid' de la section 'global').
willy tarreau0f7af912005-12-17 12:21:26 +0100395
willy tarreaua41a8b42005-12-17 14:02:24 +0100396- le couple <adresse_IP>:<plage_ports> peut être répété indéfiniment pour
397 demander au relais d'écouter également sur d'autres adresses et/ou d'autres
398 plages de ports. Pour cela, il suffit de séparer les couples par une virgule.
399
400Exemples :
willy tarreau0f7af912005-12-17 12:21:26 +0100401---------
willy tarreaua41a8b42005-12-17 14:02:24 +0100402 listen http_proxy :80
403 listen x11_proxy 127.0.0.1:6000-6009
404 listen smtp_proxy 127.0.0.1:25,127.0.0.1:587
405 listen ldap_proxy :389,:663
willy tarreau0f7af912005-12-17 12:21:26 +0100406
willy tarreaua41a8b42005-12-17 14:02:24 +0100407Si toutes les adresses ne tiennent pas sur une ligne, il est possible d'en
408rajouter à l'aide du mot clé 'bind'. Dans ce cas, il n'est même pas nécessaire
409de spécifier la première adresse sur la ligne listen, ce qui facilite parfois
410l'écriture de configurations :
411
412 bind [ <adresse_IP>:<plage_ports>[,...] ]
413
414Exemples :
415----------
416 listen http_proxy
417 bind :80,:443
willy tarreauc5f73ed2005-12-18 01:26:38 +0100418 bind 10.0.0.1:10080,10.0.0.1:10443
willy tarreau0f7af912005-12-17 12:21:26 +0100419
willy tarreauc29948c2005-12-17 13:10:27 +01004202.1) Inhibition d'un service
421----------------------------
willy tarreaueedaa9f2005-12-17 14:08:03 +0100422Un service peut être désactivé pour des besoins de maintenance, sans avoir à
willy tarreauc29948c2005-12-17 13:10:27 +0100423commenter toute une partie du fichier. Il suffit de positionner le mot clé
424"disabled" dans sa section :
willy tarreau0f7af912005-12-17 12:21:26 +0100425
426 listen smtp_proxy 0.0.0.0:25
willy tarreauc5f73ed2005-12-18 01:26:38 +0100427 disabled
willy tarreau0f7af912005-12-17 12:21:26 +0100428
willy tarreaueedaa9f2005-12-17 14:08:03 +0100429Remarque: le mot clé 'enabled' permet de réactiver un service préalablement
willy tarreauc5f73ed2005-12-18 01:26:38 +0100430 désactivé par le mot clé 'disabled', par exemple à cause d'une
431 configuration par défaut.
willy tarreaueedaa9f2005-12-17 14:08:03 +0100432
willy tarreauc29948c2005-12-17 13:10:27 +01004332.2) Mode de fonctionnement
434---------------------------
willy tarreaueedaa9f2005-12-17 14:08:03 +0100435Un service peut fonctionner dans trois modes différents :
willy tarreau0f7af912005-12-17 12:21:26 +0100436 - TCP
437 - HTTP
willy tarreau532bb552006-05-13 18:40:37 +0200438 - état de santé
willy tarreau0f7af912005-12-17 12:21:26 +0100439
440Mode TCP
441--------
willy tarreau64a3cc32005-12-18 01:13:11 +0100442Dans ce mode, le service relaye, dès leur établissement, les connexions TCP
443vers un ou plusieurs serveurs. Aucun traitement n'est effectué sur le flux. Il
444s'agit simplement d'une association
445 source<adresse:port> -> destination<adresse:port>.
willy tarreauc29948c2005-12-17 13:10:27 +0100446Pour l'utiliser, préciser le mode TCP sous la déclaration du relais.
willy tarreau0f7af912005-12-17 12:21:26 +0100447
willy tarreauc29948c2005-12-17 13:10:27 +0100448Exemple :
449---------
willy tarreau0f7af912005-12-17 12:21:26 +0100450 listen smtp_proxy 0.0.0.0:25
willy tarreauc5f73ed2005-12-18 01:26:38 +0100451 mode tcp
willy tarreau0f7af912005-12-17 12:21:26 +0100452
453Mode HTTP
454---------
willy tarreauc29948c2005-12-17 13:10:27 +0100455Dans ce mode, le service relaye les connexions TCP vers un ou plusieurs
456serveurs, une fois qu'il dispose d'assez d'informations pour en prendre la
willy tarreauc5f73ed2005-12-18 01:26:38 +0100457décision. Les en-têtes HTTP sont analysés pour y trouver un éventuel cookie, et
willy tarreauc29948c2005-12-17 13:10:27 +0100458certains d'entre-eux peuvent être modifiés par le biais d'expressions
459régulières. Pour activer ce mode, préciser le mode HTTP sous la déclaration du
460relais.
willy tarreau0f7af912005-12-17 12:21:26 +0100461
willy tarreauc29948c2005-12-17 13:10:27 +0100462Exemple :
463---------
willy tarreau0f7af912005-12-17 12:21:26 +0100464 listen http_proxy 0.0.0.0:80
willy tarreauc5f73ed2005-12-18 01:26:38 +0100465 mode http
willy tarreau0f7af912005-12-17 12:21:26 +0100466
467Mode supervision
468----------------
willy tarreauc29948c2005-12-17 13:10:27 +0100469Il s'agit d'un mode offrant à un composant externe une visibilité de l'état de
470santé du service. Il se contente de retourner "OK" à tout client se connectant
471sur son port. Il peut être utilisé avec des répartiteurs de charge évolués pour
willy tarreau197e8ec2005-12-17 14:10:59 +0100472déterminer quels sont les services utilisables. Si l'option 'httpchk' est
473activée, alors la réponse changera en 'HTTP/1.0 200 OK' pour satisfaire les
474attentes de composants sachant tester en HTTP. Pour activer ce mode, préciser
willy tarreauc29948c2005-12-17 13:10:27 +0100475le mode HEALTH sous la déclaration du relais.
willy tarreau0f7af912005-12-17 12:21:26 +0100476
willy tarreauc29948c2005-12-17 13:10:27 +0100477Exemple :
478---------
willy tarreau197e8ec2005-12-17 14:10:59 +0100479 # réponse simple : 'OK'
willy tarreau0f7af912005-12-17 12:21:26 +0100480 listen health_check 0.0.0.0:60000
willy tarreauc5f73ed2005-12-18 01:26:38 +0100481 mode health
willy tarreau0f7af912005-12-17 12:21:26 +0100482
willy tarreau197e8ec2005-12-17 14:10:59 +0100483 # réponse HTTP : 'HTTP/1.0 200 OK'
484 listen http_health_check 0.0.0.0:60001
willy tarreauc5f73ed2005-12-18 01:26:38 +0100485 mode health
486 option httpchk
willy tarreau197e8ec2005-12-17 14:10:59 +0100487
willy tarreau0f7af912005-12-17 12:21:26 +0100488
willy tarreau532bb552006-05-13 18:40:37 +02004892.2.1 Supervision
490-----------------
willy tarreauc5f73ed2005-12-18 01:26:38 +0100491Les versions 1.1.32 et 1.2.6 apportent une nouvelle solution pour valider le
492bon fonctionnement du proxy sans perturber le service. Le mot-clé 'monitor-net'
493a été créé dans le butd de spécifier un réseau d'équipements qui ne PEUVENT PAS
494utiliser le service pour autre chose que des tests de fonctionnement. C'est
495particulièrement adapté aux proxies TCP, car cela empêche le proxy de relayer
496des établissements de connexion émis par un outil de surveillance.
497
498Lorsque c'est utilisé sur un proxy TCP, la connexion est acceptée puis refermée
499et rien n'est logué. C'est suffisant pour qu'un répartiteur de charge en amont
500détecte que le service est disponible.
501
502Lorsque c'est utilisé sur un proxy HTTP, la connexion est acceptée, rien n'est
503logué, puis la réponse suivante est envoyée et la session refermée :
504"HTTP/1.0 200 OK". C'est normalement suffisant pour qu'un répartiteur de charge
505HTTP en amont détecte le service comme opérationnel, aussi bien à travers des
506tests TCP que HTTP.
507
508Les proxies utilisant le mot-clé 'monitor-net' peuvent accessoirement se passer
509de l'option 'dontlognull', ce qui permettra de loguer les connexions vides
510émises depuis d'autres adresses que celles du réseau de tests.
511
512Exemple :
513---------
514
515 listen tse-proxy
516 bind :3389,:1494,:5900 # TSE, ICA and VNC at once.
517 mode tcp
518 balance roundrobin
519 server tse-farm 192.168.1.10
520 monitor-net 192.168.1.252/31 # L4 load-balancers on .252 and .253
521
522
willy tarreauc29948c2005-12-17 13:10:27 +01005232.3) Limitation du nombre de connexions simultanées
524---------------------------------------------------
525Le paramètre "maxconn" permet de fixer la limite acceptable en nombre de
526connexions simultanées par proxy. Chaque proxy qui atteint cette valeur cesse
527d'écouter jusqu'à libération d'une connexion. Voir plus loin concernant les
528limitations liées au système.
willy tarreau0f7af912005-12-17 12:21:26 +0100529
willy tarreauc29948c2005-12-17 13:10:27 +0100530Exemple :
531---------
532 listen tiny_server 0.0.0.0:80
533 maxconn 10
willy tarreau0f7af912005-12-17 12:21:26 +0100534
535
willy tarreauc29948c2005-12-17 13:10:27 +01005362.4) Arrêt en douceur
537---------------------
willy tarreau64a3cc32005-12-18 01:13:11 +0100538Il est possible d'arrêter les services en douceur en envoyant un signal
willy tarreau22739ef2006-01-20 20:43:32 +0100539SIGUSR1 au processus relais. Tous les services seront alors mis en phase
willy tarreau64a3cc32005-12-18 01:13:11 +0100540d'arrêt, mais pourront continuer d'accepter des connexions pendant un temps
541défini par le paramètre 'grace' (en millisecondes). Cela permet par exemple,
542de faire savoir rapidement à un répartiteur de charge qu'il ne doit plus
543utiliser un relais, tout en continuant d'assurer le service le temps qu'il
544s'en rende compte.
545
546Remarque :
547----------
548Les connexions actives ne sont jamais cassées. Dans le pire des cas, il faudra
willy tarreau22739ef2006-01-20 20:43:32 +0100549attendre en plus leur expiration avant l'arrêt total du processus, ou bien tuer
550manuellement le processus par l'envoi d'un signal SIGTERM. La valeur par défaut
551du paramètre 'grace' est 0 (pas de grâce, arrêt immédiat de l'écoute).
willy tarreau0f7af912005-12-17 12:21:26 +0100552
553Exemple :
554---------
willy tarreauc29948c2005-12-17 13:10:27 +0100555 # arrêter en douceur par 'killall -USR1 haproxy'
willy tarreau0f7af912005-12-17 12:21:26 +0100556 # le service tournera encore 10 secondes après la demande d'arrêt
557 listen http_proxy 0.0.0.0:80
willy tarreauc5f73ed2005-12-18 01:26:38 +0100558 mode http
559 grace 10000
willy tarreau0f7af912005-12-17 12:21:26 +0100560
willy tarreauc29948c2005-12-17 13:10:27 +0100561 # ce port n'est testé que par un répartiteur de charge.
willy tarreau0f7af912005-12-17 12:21:26 +0100562 listen health_check 0.0.0.0:60000
willy tarreauc5f73ed2005-12-18 01:26:38 +0100563 mode health
564 grace 0
willy tarreau0f7af912005-12-17 12:21:26 +0100565
willy tarreau39df2dc2006-01-29 21:56:05 +0100566A partir de la version 1.2.8, un nouveau mécanisme de reconfiguration à chaud
willy tarreau22739ef2006-01-20 20:43:32 +0100567a été introduit. Il est désormais possible de mettre les proxies en "pause" en
568envoyant un signal SIGTTOU aux processus. Cela désactivera les sockets d'écoute
569sans casser les sessions existantes. Suite à cela, l'envoi d'un signal SIGTTIN
570réactivera les sockets d'écoute. Ceci est très pratique pour tenter de charger
571une nouvelle configuration ou même une nouvelle version de haproxy sans casser
572les connexions existantes. Si le rechargement s'effectue correctement, il ne
573reste plus qu'à envoyer un signal SIGUSR1 aux anciens processus, ce qui
574provoquera leur arrêt immédiat dès que leurs connexions seront terminées ; en
575revanche, si le rechargement échoue, il suffit d'envoyer un signal SIGTTIN pour
576remettre les ports en écoute et rétablir le service immédiatement. Veuillez
577noter que le paramètre 'grace' est ignoré pour le signal SIGTTOU ainsi que le
578signal SIGUSR1 une fois le processus en pause. Aussi, il peut s'avérer très
579utile de sauver le fichier de pid avant de démarrer une nouvelle instance.
580
willy tarreau34f45302006-04-15 21:37:14 +0200581Ce mécanisme est pleinement exploité à partir de la version 1.2.11 avec les
willy tarreau532bb552006-05-13 18:40:37 +0200582options '-st' et '-sf' (voir ci-dessous).
583
5842.4) Reconfiguration à chaud
585----------------------------
586Les paramètres '-st' et '-sf' sont utilisés pour informer des processus
587existants que la configuration va être rechargée. Ils recevront le signal
588SIGTTOU, leur demandant de libérer les ports en écoute afin que le nouveau
589processus puisse les prendre. Si quoi que ce soit se passe mal, le nouveau
590processus leur enverra un signal SIGTTIN pour leur indiquer qu'ils peuvent
591se remettre en écoute et continuer leur travail. En revanche, si la
592configuration se charge correctement, alors ils recevront un signal de demande
593de fin de travail en douceur (-sf), ou de terminaison immédiate (-st) qui
594coupera les sessions en cours. Un usage typique tel que celui-ci permet de
595recharger une configuration sans interruption de service :
596
597 # haproxy -p /var/run/haproxy.pid -sf $(cat /var/run/haproxy.pid)
598
willy tarreau0f7af912005-12-17 12:21:26 +0100599
willy tarreauc29948c2005-12-17 13:10:27 +01006002.5) Temps d'expiration des connexions
601--------------------------------------
602Il est possible de paramétrer certaines durées d'expiration au niveau des
603connexions TCP. Trois temps indépendants sont configurables et acceptent des
604valeurs en millisecondes. Si l'une de ces trois temporisations est dépassée, la
605session est terminée à chaque extrémité.
willy tarreau0f7af912005-12-17 12:21:26 +0100606
607 - temps d'attente d'une donnée de la part du client, ou de la
608 possibilité de lui envoyer des données : "clitimeout" :
609
willy tarreauc5f73ed2005-12-18 01:26:38 +0100610 # time-out client à 2mn30.
611 clitimeout 150000
willy tarreau0f7af912005-12-17 12:21:26 +0100612
613 - temps d'attente d'une donnée de la part du serveur, ou de la
614 possibilité de lui envoyer des données : "srvtimeout" :
615
willy tarreauc5f73ed2005-12-18 01:26:38 +0100616 # time-out serveur à 30s.
617 srvtimeout 30000
willy tarreau0f7af912005-12-17 12:21:26 +0100618
619 - temps d'attente de l'établissement d'une connexion vers un serveur
620 "contimeout" :
621
willy tarreauc29948c2005-12-17 13:10:27 +0100622 # on abandonne si la connexion n'est pas établie après 4 secondes
willy tarreauc5f73ed2005-12-18 01:26:38 +0100623 contimeout 4000
willy tarreau0f7af912005-12-17 12:21:26 +0100624
willy tarreauc29948c2005-12-17 13:10:27 +0100625Remarques :
626-----------
627 - "contimeout" et "srvtimeout" n'ont pas d'utilité dans le cas du serveur de
628 type "health".
629 - sous de fortes charges, ou sur un réseau saturé ou défectueux, il est
willy tarreau64a3cc32005-12-18 01:13:11 +0100630 possible de perdre des paquets. Du fait que la première retransmission
631 TCP n'ait lieu qu'au bout de 3 secoudes, fixer un timeout de connexion
632 inférieur à 3 secondes ne permet pas de se rattraper sur la perte
633 de paquets car la session aura été abandonnée avant la première
634 retransmission. Une valeur de 4 secondes réduira considérablement
635 le nombre d'échecs de connexion.
willy tarreau0f7af912005-12-17 12:21:26 +0100636
willy tarreauc29948c2005-12-17 13:10:27 +01006372.6) Tentatives de reconnexion
638------------------------------
willy tarreau0f7af912005-12-17 12:21:26 +0100639Lors d'un échec de connexion vers un serveur, il est possible de
640retenter (potentiellement vers un autre serveur, en cas de répartition
641de charge). Le nombre de nouvelles tentatives infructueuses avant
willy tarreauc29948c2005-12-17 13:10:27 +0100642abandon est fourni par le paramètre "retries".
willy tarreau0f7af912005-12-17 12:21:26 +0100643
willy tarreauc29948c2005-12-17 13:10:27 +0100644Exemple :
645---------
willy tarreauc5f73ed2005-12-18 01:26:38 +0100646 # on essaie encore trois fois maxi
647 retries 3
willy tarreau0f7af912005-12-17 12:21:26 +0100648
willy tarreau34f45302006-04-15 21:37:14 +0200649Il est à noter que la tentative de reconnexion peut amener à utiliser un autre
650serveur si le premier a disparu entre deux tentatives de connexion.
651
willy tarreau0f7af912005-12-17 12:21:26 +0100652
willy tarreauc29948c2005-12-17 13:10:27 +01006532.7) Adresse du serveur
654-----------------------
655Le serveur vers lequel sont redirigées les nouvelles connexions est défini par
656le paramètre "dispatch" sous la forme <adresse_ip>:<port>. Il correspond à un
657serveur d'assignation de cookie dans le cas où le service consiste à assurer
658uniquement une persistence HTTP, ou bien simplement au serveur destination dans
willy tarreaua41a8b42005-12-17 14:02:24 +0100659le cas de relayage TCP simple. Cet ancien mode ne permet pas de tester l'état
660du serveur distant, et il est maintenant recommandé d'utiliser de préférence
661le mode 'balance'.
willy tarreau0f7af912005-12-17 12:21:26 +0100662
willy tarreauc29948c2005-12-17 13:10:27 +0100663Exemple :
664---------
willy tarreauc5f73ed2005-12-18 01:26:38 +0100665 # on envoie toutes les nouvelles connexions ici
666 dispatch 192.168.1.2:80
willy tarreau0f7af912005-12-17 12:21:26 +0100667
willy tarreauc29948c2005-12-17 13:10:27 +0100668Remarque :
669----------
670Ce paramètre n'a pas d'utilité pour un serveur en mode 'health', ni en mode
671'balance'.
willy tarreau0f7af912005-12-17 12:21:26 +0100672
willy tarreau0f7af912005-12-17 12:21:26 +0100673
willy tarreau240afa62005-12-17 13:14:35 +01006742.8) Adresse de sortie
675----------------------
willy tarreaua41a8b42005-12-17 14:02:24 +0100676Il est possible de forcer l'adresse utilisée pour établir les connexions vers
677les serveurs à l'aide du paramètre "source". Il est même possible de forcer le
678port, bien que cette fonctionnalité se limite à des usages très spécifiques.
679C'est particulièrement utile en cas d'adressage multiple, et plus généralement
willy tarreau64a3cc32005-12-18 01:13:11 +0100680pour permettre aux serveurs de trouver le chemin de retour dans des contextes
681de routage difficiles. Si l'adresse est '0.0.0.0' ou '*' ou vide, elle sera
682choisie librement par le systeme. Si le port est '0' ou vide, il sera choisi
683librement par le système. Il est à noter que depuis la version 1.1.18, les
684tests de bon fonctionnement des serveurs seront aussi effectués à partir de la
685source spécifiée par ce paramètre.
willy tarreau240afa62005-12-17 13:14:35 +0100686
687Exemples :
688----------
willy tarreaua41a8b42005-12-17 14:02:24 +0100689 listen http_proxy *:80
willy tarreauc5f73ed2005-12-18 01:26:38 +0100690 # toutes les connexions prennent l'adresse 192.168.1.200
691 source 192.168.1.200:0
willy tarreau240afa62005-12-17 13:14:35 +0100692
willy tarreaua41a8b42005-12-17 14:02:24 +0100693 listen rlogin_proxy *:513
willy tarreauc5f73ed2005-12-18 01:26:38 +0100694 # utiliser l'adresse 192.168.1.200 et le port réservé 900
695 source 192.168.1.200:900
willy tarreau240afa62005-12-17 13:14:35 +0100696
697
6982.9) Définition du nom du cookie
willy tarreauc29948c2005-12-17 13:10:27 +0100699--------------------------------
700En mode HTTP, il est possible de rechercher la valeur d'un cookie pour savoir
701vers quel serveur aiguiller la requête utilisateur. Le nom du cookie est donné
702par le paramètre "cookie".
willy tarreau0f7af912005-12-17 12:21:26 +0100703
willy tarreauc29948c2005-12-17 13:10:27 +0100704Exemple :
705---------
willy tarreaua41a8b42005-12-17 14:02:24 +0100706 listen http_proxy :80
willy tarreauc5f73ed2005-12-18 01:26:38 +0100707 mode http
708 cookie SERVERID
willy tarreau0f7af912005-12-17 12:21:26 +0100709
willy tarreauc29948c2005-12-17 13:10:27 +0100710On peut modifier l'utilisation du cookie pour la rendre plus intelligente
711vis-à-vis des applications relayées. Il est possible, notamment de supprimer ou
712réécrire un cookie retourné par un serveur accédé en direct, et d'insérer un
713cookie dans une réponse HTTP adressée à un serveur sélectionné en répartition
willy tarreau240afa62005-12-17 13:14:35 +0100714de charge, et même de signaler aux proxies amont de ne pas cacher le cookie
715inséré.
willy tarreauc29948c2005-12-17 13:10:27 +0100716
717Exemples :
718----------
willy tarreau5cbea6f2005-12-17 12:48:26 +0100719
720Pour ne conserver le cookie qu'en accès indirect, donc à travers le
willy tarreauc29948c2005-12-17 13:10:27 +0100721dispatcheur, et supprimer toutes ses éventuelles occurences lors des accès
722directs :
willy tarreau5cbea6f2005-12-17 12:48:26 +0100723
willy tarreauc5f73ed2005-12-18 01:26:38 +0100724 cookie SERVERID indirect
willy tarreau5cbea6f2005-12-17 12:48:26 +0100725
willy tarreauc29948c2005-12-17 13:10:27 +0100726Pour remplacer la valeur d'un cookie existant par celle attribuée à un serveur,
727lors d'un accès direct :
willy tarreau5cbea6f2005-12-17 12:48:26 +0100728
willy tarreauc5f73ed2005-12-18 01:26:38 +0100729 cookie SERVERID rewrite
willy tarreau5cbea6f2005-12-17 12:48:26 +0100730
willy tarreau64a3cc32005-12-18 01:13:11 +0100731Pour créer un cookie comportant la valeur attribuée à un serveur lors d'un
732accès en répartition de charge interne. Dans ce cas, il est souhaitable que
733tous les serveurs aient un cookie renseigné. Un serveur non assigné d'un cookie
willy tarreau8337c6b2005-12-17 13:41:01 +0100734retournera un cookie vide (cookie de suppression) :
willy tarreau5cbea6f2005-12-17 12:48:26 +0100735
willy tarreauc5f73ed2005-12-18 01:26:38 +0100736 cookie SERVERID insert
willy tarreau5cbea6f2005-12-17 12:48:26 +0100737
willy tarreau0174f312005-12-18 01:02:42 +0100738Pour réutiliser un cookie applicatif et lui préfixer l'identifiant du serveur,
739puis le supprimer dans les requêtes suivantes, utiliser l'option 'prefix'. Elle
740permet d'insérer une instance de haproxy devant une application sans risquer
741d'incompatibilités dûes à des clients qui ne supporteraient pas d'apprendre
742plus d'un cookie :
743
744 cookie JSESSIONID prefix
745
willy tarreau240afa62005-12-17 13:14:35 +0100746Pour insérer un cookie, en s'assurant qu'un cache en amont ne le stockera pas,
747ajouter le mot clé 'nocache' après 'insert' :
748
willy tarreauc5f73ed2005-12-18 01:26:38 +0100749 cookie SERVERID insert nocache
willy tarreau240afa62005-12-17 13:14:35 +0100750
willy tarreau64a3cc32005-12-18 01:13:11 +0100751Pour insérer un cookie seulement suite aux requêtes de type POST, ajouter le
752mot clé 'postonly' après 'insert' :
willy tarreaucd878942005-12-17 13:27:43 +0100753
willy tarreauc5f73ed2005-12-18 01:26:38 +0100754 cookie SERVERID insert postonly
willy tarreaucd878942005-12-17 13:27:43 +0100755
willy tarreau240afa62005-12-17 13:14:35 +0100756
willy tarreau96d40372005-12-17 13:11:56 +0100757Remarques :
758-----------
willy tarreau64a3cc32005-12-18 01:13:11 +0100759- Il est possible de combiner 'insert' avec 'indirect' ou 'rewrite' pour
760 s'adapter à des applications générant déjà le cookie, avec un contenu
761 invalide. Il suffit pour cela de les spécifier sur la même ligne.
willy tarreaueedaa9f2005-12-17 14:08:03 +0100762
willy tarreau96d40372005-12-17 13:11:56 +0100763- dans le cas où 'insert' et 'indirect' sont spécifiés, le cookie n'est jamais
764 transmis au serveur vu qu'il n'en a pas connaissance et ne pourrait pas le
765 comprendre.
willy tarreaueedaa9f2005-12-17 14:08:03 +0100766
willy tarreau240afa62005-12-17 13:14:35 +0100767- il est particulièrement recommandé d'utiliser 'nocache' en mode insertion si
768 des caches peuvent se trouver entre les clients et l'instance du proxy. Dans
769 le cas contraire, un cache HTTP 1.0 pourrait cacher la réponse, incluant le
770 cookie de persistence inséré, donc provoquer des changements de serveurs pour
771 des clients partageant le même cache.
willy tarreaueedaa9f2005-12-17 14:08:03 +0100772
willy tarreau0174f312005-12-18 01:02:42 +0100773- le mode 'prefix' ne nécessite pas d'utiliser 'indirect', 'nocache', ni
774 'postonly', car tout comme le mode 'rewrite', il s'appuie sur un cookie
775 présenté par l'application qui est censée savoir à quel moment il peut
776 être émis sans risque. Toutefois, comme il nécessite de rectifier le cookie
777 présenté par le client dans chaque requête ultérieure, il est indispensable
778 de s'assurer que le client et le serveur communiqueront sans "keep-alive
779 HTTP". Dans le doute, il est recommandé d'utiliser l'option "httpclose".
780
willy tarreaucd878942005-12-17 13:27:43 +0100781- lorsque l'application est bien connue, et que les parties nécessitant de la
782 persistence sont systématiquement accédées par un formulaire en mode POST,
783 il est plus efficace encore de combiner le mot clé "postonly" avec "insert"
784 et "indirect", car la page d'accueil reste cachable, et c'est l'application
785 qui gère le 'cache-control'.
willy tarreau0f7af912005-12-17 12:21:26 +0100786
willy tarreau240afa62005-12-17 13:14:35 +01007872.10) Assignation d'un serveur à une valeur de cookie
willy tarreauc29948c2005-12-17 13:10:27 +0100788----------------------------------------------------
willy tarreau8337c6b2005-12-17 13:41:01 +0100789En mode HTTP, il est possible d'associer des valeurs de cookie à des serveurs
790par le paramètre 'server'. La syntaxe est :
willy tarreau0f7af912005-12-17 12:21:26 +0100791
willy tarreau5cbea6f2005-12-17 12:48:26 +0100792 server <identifiant> <adresse_ip>:<port> cookie <valeur>
willy tarreau0f7af912005-12-17 12:21:26 +0100793
willy tarreauc29948c2005-12-17 13:10:27 +0100794- <identifiant> est un nom quelconque de serveur utilisé pour l'identifier dans la
795 configuration et les logs.
796- <adresse_ip>:<port> est le couple adresse-port sur lequel le serveur écoute.
797- <valeur> est la valeur à reconnaître ou positionner dans le cookie.
willy tarreau0f7af912005-12-17 12:21:26 +0100798
799Exemple : le cookie SERVERID peut contenir server01 ou server02
willy tarreauc29948c2005-12-17 13:10:27 +0100800---------
willy tarreaua41a8b42005-12-17 14:02:24 +0100801 listen http_proxy :80
willy tarreauc5f73ed2005-12-18 01:26:38 +0100802 mode http
803 cookie SERVERID
804 dispatch 192.168.1.100:80
805 server web1 192.168.1.1:80 cookie server01
806 server web2 192.168.1.2:80 cookie server02
willy tarreau5cbea6f2005-12-17 12:48:26 +0100807
808Attention : la syntaxe a changé depuis la version 1.0.
willy tarreauc29948c2005-12-17 13:10:27 +0100809-----------
willy tarreau5cbea6f2005-12-17 12:48:26 +0100810
willy tarreaua41a8b42005-12-17 14:02:24 +01008113) Répartiteur de charge autonome
willy tarreauc29948c2005-12-17 13:10:27 +0100812=================================
willy tarreau5cbea6f2005-12-17 12:48:26 +0100813
willy tarreauc29948c2005-12-17 13:10:27 +0100814Le relais peut effectuer lui-même la répartition de charge entre les différents
815serveurs définis pour un service donné, en mode TCP comme en mode HTTP. Pour
816cela, on précise le mot clé 'balance' dans la définition du service,
willy tarreau34f45302006-04-15 21:37:14 +0200817éventuellement suivi du nom d'un algorithme de répartition. Jusqu'à la version
8181.2.11, seul 'roundrobin' était géré, et c'est aussi la valeur implicite par
819défaut. Avec la version 1.2.12, le nouveau mot clé 'source' est apparu. Il est
820évident qu'en cas d'utilisation du répartiteur interne, il ne faudra pas
willy tarreauc29948c2005-12-17 13:10:27 +0100821spécifier d'adresse de dispatch, et qu'il faudra au moins un serveur.
willy tarreau5cbea6f2005-12-17 12:48:26 +0100822
823Exemple : même que précédemment en répartition interne
willy tarreauc29948c2005-12-17 13:10:27 +0100824---------
willy tarreau5cbea6f2005-12-17 12:48:26 +0100825
willy tarreaua41a8b42005-12-17 14:02:24 +0100826 listen http_proxy :80
willy tarreauc5f73ed2005-12-18 01:26:38 +0100827 mode http
828 cookie SERVERID
829 balance roundrobin
830 server web1 192.168.1.1:80 cookie server01
831 server web2 192.168.1.2:80 cookie server02
willy tarreau5cbea6f2005-12-17 12:48:26 +0100832
willy tarreaua41a8b42005-12-17 14:02:24 +0100833Depuis la version 1.1.22, il est possible de déterminer automatiquement le port
834du serveur vers lequel sera envoyée la connexion, en fonction du port d'écoute
835sur lequel le client s'est connecté. En effet, il y a 4 possibilités pour le
836champ <port> de l'adresse serveur :
837
838 - non spécifié ou nul :
839 la connexion sera envoyée au serveur sur le même port que celui sur
840 lequel le relais a reçu la connexion.
841
842 - valeur numérique (seul cas supporté pour les versions antérieures) :
843 le serveur recevra la connexion sur le port désigné.
844
845 - valeur numérique précédée d'un signe '+' :
846 la connexion sera envoyée au serveur sur le même port que celui sur
847 lequel le relais a reçu la connexion, auquel on ajoute la valeur désignée.
848
849 - valeur numérique précédée d'un signe '-' :
850 la connexion sera envoyée au serveur sur le même port que celui sur
851 lequel le relais a reçu la connexion, duquel on soustrait la valeur
852 désignée.
853
854Exemples :
855----------
856
857# même que précédemment
858
859 listen http_proxy :80
willy tarreauc5f73ed2005-12-18 01:26:38 +0100860 mode http
861 cookie SERVERID
862 balance roundrobin
863 server web1 192.168.1.1 cookie server01
864 server web2 192.168.1.2 cookie server02
willy tarreaua41a8b42005-12-17 14:02:24 +0100865
866# relayage simultané des ports 80 et 81 et 8080-8089
867
868 listen http_proxy :80,:81,:8080-8089
willy tarreauc5f73ed2005-12-18 01:26:38 +0100869 mode http
870 cookie SERVERID
871 balance roundrobin
872 server web1 192.168.1.1 cookie server01
873 server web2 192.168.1.2 cookie server02
willy tarreaua41a8b42005-12-17 14:02:24 +0100874
875# relayage TCP des ports 25, 389 et 663 vers les ports 1025, 1389 et 1663
876
877 listen http_proxy :25,:389,:663
willy tarreauc5f73ed2005-12-18 01:26:38 +0100878 mode tcp
879 balance roundrobin
880 server srv1 192.168.1.1:+1000
881 server srv2 192.168.1.2:+1000
willy tarreaua41a8b42005-12-17 14:02:24 +0100882
willy tarreau34f45302006-04-15 21:37:14 +0200883Comme indiqué précédemment, la version 1.2.12 apporta le nouveau mot clé
884'source'. Lorsque celui-ci est utilisé, l'adresse IP du client est hachée et
885distribuée de manière homogène parmi les serveurs disponibles, de sorte qu'une
886même adresse IP aille toujours sur le même serveur tant qu'il n'y a aucun
887changement dans le nombre de serveurs disponibles. Ceci peut être utilisé par
888exemple pour attacher le HTTP et le HTTPS sur un même serveur pour un même
889client. Cela peut également être utilisé pour améliorer la persistance
890lorsqu'une partie de la population des clients n'accepte pas les cookies. Dans
891ce cas, seuls ces derniers seront perturbés par la perte d'un serveur.
892
893NOTE: il est important de prendre en compte le fait que beaucoup d'internautes
894 naviguent à travers des fermes de proxies qui assignent des adresses IP
895 différentes à chaque requête. D'autres internautes utilisent des liens à
896 la demande et obtiennent une adresse IP différente à chaque connexion. De
897 ce fait, le paramètre 'source' doit être utilisé avec une extrème
898 précaution.
899
900Exemples :
901----------
902
903# assurer qu'une même adresse IP ira sur le même serveur pour tout service
904
905 listen http_proxy
906 bind :80,:443
907 mode http
908 balance source
909 server web1 192.168.1.1
910 server web2 192.168.1.2
911
912# améliorer la persistance par l'utilisation de la source en plus du cookie :
913
914 listen http_proxy :80
915 mode http
916 cookie SERVERID
917 balance source
918 server web1 192.168.1.1 cookie server01
919 server web2 192.168.1.2 cookie server02
920
willy tarreau0f7af912005-12-17 12:21:26 +0100921
willy tarreauc29948c2005-12-17 13:10:27 +01009223.1) Surveillance des serveurs
923------------------------------
willy tarreau64a3cc32005-12-18 01:13:11 +0100924Il est possible de tester l'état des serveurs par établissement de connexion
925TCP ou par envoi d'une requête HTTP. Un serveur hors d'usage ne sera pas
926utilisé dans le processus de répartition de charge interne. Pour activer la
927surveillance, ajouter le mot clé 'check' à la fin de la déclaration du serveur.
928Il est possible de spécifier l'intervalle (en millisecondes) séparant deux
929tests du serveur par le paramètre "inter", le nombre d'échecs acceptés par le
930paramètre "fall", et le nombre de succès avant reprise par le paramètre "rise".
931Les paramètres non précisés prennent les valeurs suivantes par défaut :
willy tarreau34f45302006-04-15 21:37:14 +0200932
willy tarreaue47c8d72005-12-17 12:55:52 +0100933 - inter : 2000
934 - rise : 2
935 - fall : 3
willy tarreaua41a8b42005-12-17 14:02:24 +0100936 - port : port de connexion du serveur
willy tarreau5cbea6f2005-12-17 12:48:26 +0100937
willy tarreaubc4e1fb2005-12-17 13:32:07 +0100938Le mode par défaut consiste à établir des connexions TCP uniquement. Dans
willy tarreau64a3cc32005-12-18 01:13:11 +0100939certains cas de pannes, des serveurs peuvent continuer à accepter les
940connexions sans les traiter. Depuis la version 1.1.16, haproxy est en mesure
941d'envoyer des requêtes HTTP courtes et très peu coûteuses. Les versions 1.1.16
942et 1.1.17 utilisent "OPTIONS / HTTP/1.0". Dans les versions 1.1.18 à 1.1.20,
943les requêtes ont été changées en "OPTIONS * HTTP/1.0" pour des raisons de
944contrôle d'accès aux ressources. Cependant, cette requête documentée dans la
945RFC2068 n'est pas comprise par tous les serveurs. Donc à partir de la version
9461.1.21, la requête par défaut est revenue à "OPTIONS / HTTP/1.0", mais il est
947possible de paramétrer la partie URI. Les requêtes OPTIONS présentent
948l'avantage d'être facilement extractibles des logs, et de ne pas induire
949d'accès aux fichiers côté serveur. Seules les réponses 2xx et 3xx sont
950considérées valides, les autres (y compris non-réponses) aboutissent à un
951échec. Le temps maximal imparti pour une réponse est égal à l'intervalle entre
952deux tests (paramètre "inter"). Pour activer ce mode, spécifier l'option
953"httpchk", éventuellement suivie d'une méthode et d'une URI. L'option "httpchk"
954accepte donc 4 formes :
willy tarreau34f45302006-04-15 21:37:14 +0200955
willy tarreaueedaa9f2005-12-17 14:08:03 +0100956 - option httpchk -> OPTIONS / HTTP/1.0
957 - option httpchk URI -> OPTIONS <URI> HTTP/1.0
958 - option httpchk METH URI -> <METH> <URI> HTTP/1.0
959 - option httpchk METH URI VER -> <METH> <URI> <VER>
willy tarreau34f45302006-04-15 21:37:14 +0200960
willy tarreauc5f73ed2005-12-18 01:26:38 +0100961Voir les exemples ci-après.
willy tarreaubc4e1fb2005-12-17 13:32:07 +0100962
willy tarreau8337c6b2005-12-17 13:41:01 +0100963Depuis la version 1.1.17, il est possible de définir des serveurs de secours,
964utilisés uniquement lorsqu'aucun des autres serveurs ne fonctionne. Pour cela,
965ajouter le mot clé "backup" sur la ligne de définition du serveur. Un serveur
966de secours n'est appelé que lorsque tous les serveurs normaux, ainsi que tous
967les serveurs de secours qui le précèdent sont hors d'usage. Il n'y a donc pas
Willy TARREAU3481c462006-03-01 22:37:57 +0100968de répartition de charge entre des serveurs de secours par défaut. A partir
969de la version 1.2.9, il est possible de les utiliser simultanément grâce à
970l'option 'allbackups'. Ce type de serveurs peut servir à retourner des pages
971d'indisponibilité de service. Dans ce cas, il est préférable de ne pas affecter
972de cookie, afin que les clients qui le rencontrent n'y soient pas affectés
973définitivement. Le fait de ne pas mettre de cookie envoie un cookie vide, ce
974qui a pour effet de supprimer un éventuel cookie affecté précédemment.
willy tarreau8337c6b2005-12-17 13:41:01 +0100975
willy tarreaua41a8b42005-12-17 14:02:24 +0100976Depuis la version 1.1.22, il est possible d'envoyer les tests de fonctionnement
977vers un port différent de celui de service. C'est nécessaire principalement
978pour les configurations où le serveur n'a pas de port prédéfini, par exemple
979lorsqu'il est déduit du port d'acceptation de la connexion. Pour cela, utiliser
980le paramètre 'port' suivi du numéro de port devant répondre aux requêtes.
981
willy tarreau64a3cc32005-12-18 01:13:11 +0100982Enfin, depuis la version 1.1.17, il est possible de visualiser rapidement
983l'état courant de tous les serveurs. Pour cela, il suffit d'envoyer un signal
984SIGHUP au processus proxy. L'état de tous les serveurs de tous les proxies est
985envoyé dans les logs en niveau "notice", ainsi que sur la sortie d'erreurs si
986elle est active. C'est une bonne raison pour avoir au moins un serveur de logs
987local en niveau notice.
willy tarreau8337c6b2005-12-17 13:41:01 +0100988
willy tarreau982249e2005-12-18 00:57:06 +0100989Depuis la version 1.1.18 (et 1.2.1), un message d'urgence est envoyé dans les
990logs en niveau 'emerg' si tous les serveurs d'une même instance sont tombés,
991afin de notifier l'administrateur qu'il faut prendre une action immédiate.
992
willy tarreau0174f312005-12-18 01:02:42 +0100993Depuis les versions 1.1.30 et 1.2.3, plusieurs serveurs peuvent partager la
994même valeur de cookie. C'est particulièrement utile en mode backup, pour
995sélectionner des chemins alternatifs pour un serveur donné, pour mettre en
996oeuvre l'arrêt en douceur d'un serveur, ou pour diriger les clients
997temporairement vers une page d'erreur en attendant le redémarrage d'une
998application. Le principe est que lorsqu'un serveur est détecté comme inopérant,
999le proxy cherchera le prochain serveur possédant la même valeur de cookie pour
1000chaque client qui le demandera. S'il ne trouve pas de serveur normal, alors il
1001le cherchera parmi les serveurs de backup. Consulter le guide d'architecture
1002pour plus d'informations.
1003
willy tarreauc29948c2005-12-17 13:10:27 +01001004Exemples :
1005----------
willy tarreaua41a8b42005-12-17 14:02:24 +01001006# conf du paragraphe 3) avec surveillance TCP
willy tarreaubc4e1fb2005-12-17 13:32:07 +01001007 listen http_proxy 0.0.0.0:80
willy tarreauc5f73ed2005-12-18 01:26:38 +01001008 mode http
1009 cookie SERVERID
1010 balance roundrobin
1011 server web1 192.168.1.1:80 cookie server01 check
1012 server web2 192.168.1.2:80 cookie server02 check inter 500 rise 1 fall 2
willy tarreaubc4e1fb2005-12-17 13:32:07 +01001013
willy tarreau2f6ba652005-12-17 13:57:42 +01001014# même que précédemment avec surveillance HTTP par 'OPTIONS / HTTP/1.0'
willy tarreau5cbea6f2005-12-17 12:48:26 +01001015 listen http_proxy 0.0.0.0:80
willy tarreauc5f73ed2005-12-18 01:26:38 +01001016 mode http
1017 cookie SERVERID
1018 balance roundrobin
1019 option httpchk
1020 server web1 192.168.1.1:80 cookie server01 check
1021 server web2 192.168.1.2:80 cookie server02 check inter 500 rise 1 fall 2
willy tarreau5cbea6f2005-12-17 12:48:26 +01001022
willy tarreau2f6ba652005-12-17 13:57:42 +01001023# même que précédemment avec surveillance HTTP par 'OPTIONS /index.html HTTP/1.0'
1024 listen http_proxy 0.0.0.0:80
willy tarreauc5f73ed2005-12-18 01:26:38 +01001025 mode http
1026 cookie SERVERID
1027 balance roundrobin
1028 option httpchk /index.html
1029 server web1 192.168.1.1:80 cookie server01 check
1030 server web2 192.168.1.2:80 cookie server02 check inter 500 rise 1 fall 2
willy tarreau2f6ba652005-12-17 13:57:42 +01001031
willy tarreaueedaa9f2005-12-17 14:08:03 +01001032# idem avec surveillance HTTP par 'HEAD /index.jsp? HTTP/1.1\r\nHost: www'
1033 listen http_proxy 0.0.0.0:80
willy tarreauc5f73ed2005-12-18 01:26:38 +01001034 mode http
1035 cookie SERVERID
1036 balance roundrobin
1037 option httpchk HEAD /index.jsp? HTTP/1.1\r\nHost:\ www
1038 server web1 192.168.1.1:80 cookie server01 check
1039 server web2 192.168.1.2:80 cookie server02 check inter 500 rise 1 fall 2
willy tarreaueedaa9f2005-12-17 14:08:03 +01001040
willy tarreau0174f312005-12-18 01:02:42 +01001041# répartition avec persistence basée sur le préfixe de cookie, et arrêt en
1042# douceur utilisant un second port (81) juste pour les health-checks.
1043 listen http_proxy 0.0.0.0:80
1044 mode http
1045 cookie JSESSIONID prefix
1046 balance roundrobin
1047 option httpchk HEAD /index.jsp? HTTP/1.1\r\nHost:\ www
1048 server web1-norm 192.168.1.1:80 cookie s1 check port 81
1049 server web2-norm 192.168.1.2:80 cookie s2 check port 81
1050 server web1-stop 192.168.1.1:80 cookie s1 check port 80 backup
1051 server web2-stop 192.168.1.2:80 cookie s2 check port 80 backup
1052
willy tarreau96d40372005-12-17 13:11:56 +01001053# Insertion automatique de cookie dans la réponse du serveur, et suppression
willy tarreau240afa62005-12-17 13:14:35 +01001054# automatique dans la requête, tout en indiquant aux caches de ne pas garder
1055# ce cookie.
willy tarreauc29948c2005-12-17 13:10:27 +01001056 listen web_appl 0.0.0.0:80
willy tarreauc5f73ed2005-12-18 01:26:38 +01001057 mode http
1058 cookie SERVERID insert nocache indirect
1059 balance roundrobin
1060 server web1 192.168.1.1:80 cookie server01 check
1061 server web2 192.168.1.2:80 cookie server02 check
willy tarreau8337c6b2005-12-17 13:41:01 +01001062
willy tarreaueedaa9f2005-12-17 14:08:03 +01001063# idem avec serveur applicatif de secours sur autre site, et serveur de pages d'erreurs
willy tarreau8337c6b2005-12-17 13:41:01 +01001064 listen web_appl 0.0.0.0:80
willy tarreauc5f73ed2005-12-18 01:26:38 +01001065 mode http
1066 cookie SERVERID insert nocache indirect
1067 balance roundrobin
1068 server web1 192.168.1.1:80 cookie server01 check
1069 server web2 192.168.1.2:80 cookie server02 check
1070 server web-backup 192.168.2.1:80 cookie server03 check backup
1071 server web-excuse 192.168.3.1:80 check backup
willy tarreau5cbea6f2005-12-17 12:48:26 +01001072
willy tarreaua41a8b42005-12-17 14:02:24 +01001073# relayage SMTP+TLS avec test du serveur et serveur de backup
1074
1075 listen http_proxy :25,:587
willy tarreauc5f73ed2005-12-18 01:26:38 +01001076 mode tcp
1077 balance roundrobin
1078 server srv1 192.168.1.1 check port 25 inter 30000 rise 1 fall 2
1079 server srv2 192.168.1.2 backup
willy tarreaua41a8b42005-12-17 14:02:24 +01001080
Willy TARREAU3481c462006-03-01 22:37:57 +01001081# Utilisation d'un groupe de serveurs pour le backup (nécessite haproxy 1.2.9)
1082 listen http_proxy 0.0.0.0:80
1083 mode http
1084 balance roundrobin
1085 option httpchk
1086 server inst1 192.168.1.1:80 cookie s1 check
1087 server inst2 192.168.1.2:80 cookie s2 check
1088 server inst3 192.168.1.3:80 cookie s3 check
1089 server back1 192.168.1.10:80 check backup
1090 server back2 192.168.1.11:80 check backup
1091 option allbackups # all backups will be used
1092
willy tarreau0f7af912005-12-17 12:21:26 +01001093
willy tarreauc29948c2005-12-17 13:10:27 +010010943.2) Reconnexion vers un répartiteur en cas d'échec direct
1095----------------------------------------------------------
1096En mode HTTP, si un serveur défini par un cookie ne répond plus, les clients
1097seront définitivement aiguillés dessus à cause de leur cookie, et de ce fait,
1098définitivement privés de service. La spécification du paramètre 'redispatch'
1099autorise dans ce cas à renvoyer les connexions échouées vers le répartiteur
1100(externe ou interne) afin d'assigner un nouveau serveur à ces clients.
willy tarreau0f7af912005-12-17 12:21:26 +01001101
1102Exemple :
willy tarreauc29948c2005-12-17 13:10:27 +01001103---------
willy tarreau0f7af912005-12-17 12:21:26 +01001104 listen http_proxy 0.0.0.0:80
willy tarreauc5f73ed2005-12-18 01:26:38 +01001105 mode http
1106 cookie SERVERID
1107 dispatch 192.168.1.100:80
1108 server web1 192.168.1.1:80 cookie server01
1109 server web2 192.168.1.2:80 cookie server02
1110 redispatch # renvoyer vers dispatch si refus de connexion.
willy tarreau8337c6b2005-12-17 13:41:01 +01001111
willy tarreau64a3cc32005-12-18 01:13:11 +01001112Par défaut (et dans les versions 1.1.16 et antérieures), le paramètre
1113redispatch ne s'applique qu'aux échecs de connexion au serveur. Depuis la
1114version 1.1.17, il s'applique aussi aux connexions destinées à des serveurs
1115identifiés comme hors d'usage par la surveillance. Si l'on souhaite malgré
1116tout qu'un client disposant d'un cookie correspondant à un serveur défectueux
1117tente de s'y connecter, il faut préciser l'option "persist" :
willy tarreau8337c6b2005-12-17 13:41:01 +01001118
1119 listen http_proxy 0.0.0.0:80
willy tarreauc5f73ed2005-12-18 01:26:38 +01001120 mode http
1121 option persist
1122 cookie SERVERID
1123 dispatch 192.168.1.100:80
1124 server web1 192.168.1.1:80 cookie server01
1125 server web2 192.168.1.2:80 cookie server02
1126 redispatch # renvoyer vers dispatch si serveur HS.
willy tarreau5cbea6f2005-12-17 12:48:26 +01001127
willy tarreauc29948c2005-12-17 13:10:27 +01001128
willy tarreau34f45302006-04-15 21:37:14 +020011293.3) Assignation de poids différents à des serveurs
1130---------------------------------------------------
1131Parfois il arrive d'ajouter de nouveaux serveurs pour accroître la capacité
1132d'une ferme de serveur, mais le nouveau serveur est soit beaucoup plus petit
1133que les autres (dans le cas d'un ajout d'urgence de matériel de récupération),
1134soit plus puissant (lors d'un investissement dans du matériel neuf). Pour cette
1135raison, il semble parfois judicieux de pouvoir envoyer plus de clients vers les
1136plus gros serveurs. Jusqu'à la version 1.2.11, il était nécessaire de répliquer
1137plusieurs fois les définitions des serveurs pour augmenter leur poids. Depuis
1138la version 1.2.12, l'option 'weight' est disponible. HAProxy construit alors
1139une vue des serveurs disponibles la plus homogène possible en se basant sur
1140leur poids de sorte que la charge se distribue de la manière la plus lisse
1141possible. Le poids compris entre 1 et 256 doit refléter la capacité d'un
willy tarreau532bb552006-05-13 18:40:37 +02001142serveur par rapport aux autres. Le poids de 1 donne la fréquence d'apparition
1143la plus faible, et 256 la fréquence la plus élevée. De cette manière, si un
1144serveur disparait, les capacités restantes sont toujours respectées.
willy tarreau34f45302006-04-15 21:37:14 +02001145
1146
1147Exemple :
1148---------
1149# distribution équitable sur 2 opteron and un ancien pentium3
1150
1151 listen web_appl 0.0.0.0:80
1152 mode http
1153 cookie SERVERID insert nocache indirect
1154 balance roundrobin
1155 server pentium3-800 192.168.1.1:80 cookie server01 weight 8 check
1156 server opteron-2.0G 192.168.1.2:80 cookie server02 weight 20 check
1157 server opteron-2.4G 192.168.1.3:80 cookie server03 weight 24 check
1158 server web-backup1 192.168.2.1:80 cookie server04 check backup
1159 server web-excuse 192.168.3.1:80 check backup
1160
1161Notes :
1162-------
1163 - lorsque le poids n'est pas spécifié, la valeur par défaut est à 1
1164
1165 - le poids n'impacte pas les tests de fonctionnement (health checks), donc il
1166 est plus propre d'utiliser les poids que de répliquer le même serveur
1167 plusieurs fois.
1168
1169 - les poids s'appliquent également aux serveurs de backup si l'option
1170 'allbackups' est positionnée.
1171
1172 - le poids s'applique aussi à la répartition selon la source
1173 ('balance source').
1174
1175 - quels que soient les poids, le premier serveur sera toujours assigné en
1176 premier. Cette règle facilite les diagnostics.
1177
1178 - pour les puristes, l'algorithme de calculation de la vue des serveurs donne
1179 une priorité aux premiers serveurs, donc la vue est la plus uniforme si les
1180 serveurs sont déclarés dans l'ordre croissant de leurs poids.
1181
willy tarreau532bb552006-05-13 18:40:37 +02001182La distribution du trafic suivra exactement le séquencement suivant :
1183
1184 Request| 1 1 1 1
1185 number | 1 2 3 4 5 6 7 8 9 0 1 2 3
1186 --------+---------------------------
1187 p3-800 | X . . . . . . X . . . . .
1188 opt-20 | . X . X . X . . . X . X .
1189 opt-24 | . . X . X . X . X . X . X
1190
1191
11923.4) Limitation du nombre de sessions concurrentes par serveur
1193--------------------------------------------------------------
1194Certains serveurs web multi-processus tels qu'Apache souffrent dès qu'il y a
1195trop de sessions concurrentes, parce qu'il est très coûteux de faire
1196fonctionner des centaines ou des milliers de processus sur un système. Une
1197solution consiste à augmenter le nombre de serveurs et de répartir la charge
1198entre eux, mais cela pose un problème lorsque le but est uniquement de résister
1199à des pics de charge occasionnels.
1200
1201Pour résoudre ce problème, une nouvelle fonctionnalité a été implémentée dans
1202HAProxy 1.2.13. Il s'agit d'une limite "maxconn" par serveur, associée à une
1203file d'attente par serveur et par proxy. Ceci transforme HAProxy en un tampon
1204entre des milliers de clients et quelques serveurs. Dans bien des cas, le fait
1205de diminuer la valeur maxconn améliorera notablement les performances des
1206serveurs et diminuera les temps de réponse simplement parce que les serveurs
1207seront moins congestionnés.
1208
1209Quand une requête cherche à joindre n'importe quel serveur, le premier serveur
1210non saturé est utilisé, en respectant l'algorithme de répartition de charge. Si
1211tous les serveurs sont saturés, alors la requête sera mise dans la file
1212d'attente globale de l'instance. Elle sortira de cette file d'attente lorsque
1213toutes les requêtes précédentes auront été libérées et qu'un serveur aura été
1214libéré d'une connexion pour la traiter.
1215
1216Si une requête fait référence à un serveur en particulier (p.ex: hachage d'IP
1217source, ou persistance par cookie), et que ce server est saturé, alors la
1218requête sera mise dans la file d'attente dédiée à ce serveur. Cette file
1219d'attente est prioritaire sur la file d'attente globale, de sorte qu'il soit
1220plus facile d'atteindre le site pour les utilisateurs qui s'y trouvent déjà
1221que pour les nouveaux utilisateurs.
1222
1223Pour cela, les logs ont dû être enrichis pour indiquer le nombre de sessions
1224par serveur, la position de la requête dans les files d'attentes, et le temps
1225passé en file d'attente. Ceci aide considérablement à faire de la prévision de
1226capacité. Voir la section 'logs' plus bas pour plus d'informations.
1227
1228Exemple :
1229---------
1230 # Prendre soin du P3 qui n'a que 256 Mo de RAM.
1231 listen web_appl 0.0.0.0:80
1232 maxconn 10000
1233 mode http
1234 cookie SERVERID insert nocache indirect
1235 balance roundrobin
1236 server pentium3-800 192.168.1.1:80 cookie s1 weight 8 maxconn 100 check
1237 server opteron-2.0G 192.168.1.2:80 cookie s2 weight 20 maxconn 300 check
1238 server opteron-2.4G 192.168.1.3:80 cookie s3 weight 24 maxconn 300 check
1239 server web-backup1 192.168.2.1:80 cookie s4 check maxconn 200 backup
1240 server web-excuse 192.168.3.1:80 check backup
1241
willy tarreau8f635a42006-05-21 23:05:54 +02001242Cette option se montra si efficace pour réduire les temps de réponse des
1243serveurs que certains utilisateurs voulaient utiliser des valeurs trop basses
1244pour améliorer les performances de leurs serveurs. Seulement, ils n'étaient
1245alors plus en mesure de supporter de très fortes charges parce qu'il n'était
1246plus possible de les saturer. Pour cette raison, la version 1.2.14 a apporté la
1247limitation dynamique de connexions avec l'addition du paramètre "minconn".
1248Lorsque ce paramètre est associé à "maxconn", il active la limitation dynamique
1249basée sur la charge de l'instance. Le nombre maximal de sessions concurrentes
1250sur un serveur devient alors proportionnel au nombre de sessions de l'instance
1251par rapport à son 'maxconn'. Un minimum de <minconn> sessions sera toujours
1252permis quelle que soit la charge. Ceci assurera que les serveurs travailleront
1253au meilleur de leurs performances sous des charges normales, et qu'ils seront
1254tout de même capables de supporter de fortes pointes lorsque nécessaire. La
1255limite dynamique est calculée comme ceci :
1256
1257 srv.dyn_limit = max(srv.minconn, srv.maxconn * inst.sess / inst.maxconn)
1258
1259Exemple :
1260---------
1261 # Prendre soin du P3 qui n'a que 256 Mo de RAM.
1262 listen web_appl 0.0.0.0:80
1263 maxconn 10000
1264 mode http
1265 cookie SERVERID insert nocache indirect
1266 balance roundrobin
1267 server pentium3-800 192.168.1.1:80 cookie s1 weight 8 minconn 10 maxconn 100 check
1268 server opteron-2.0G 192.168.1.2:80 cookie s2 weight 20 minconn 30 maxconn 300 check
1269 server opteron-2.4G 192.168.1.3:80 cookie s3 weight 24 minconn 30 maxconn 300 check
1270 server web-backup1 192.168.2.1:80 cookie s4 check maxconn 200 backup
1271 server web-excuse 192.168.3.1:80 check backup
1272
1273Dans l'exemple ci-dessus, le serveur "pentium3-800' recevra au plus 100
1274connexions simultanées lorsque l'instance du proxy en atteindra 10000, et
1275recevra seulement 10 connexions simultanées tant que le proxy sera sous les 1000
1276sessions.
1277
willy tarreau532bb552006-05-13 18:40:37 +02001278Notes :
1279-------
1280 - la requête ne restera pas indéfiniment en file d'attente, elle est
1281 assujétie au paramètre 'contimeout', et si une requête ne peut pas
1282 sortir de la file avant ce time-out, soit parce que le serveur est
1283 saturé, soit parce qu'il y a trop de requêtes en file d'attente,
1284 alors elle expirera avec une erreur 503.
1285
willy tarreau8f635a42006-05-21 23:05:54 +02001286 - si seul <minconn> est spécifié, il a le même effet que <maxconn>
1287
willy tarreau532bb552006-05-13 18:40:37 +02001288 - positionner des valeurs trop basses pour 'maxconn' peut améliorer les
1289 performances mais aussi permettre à des utilisateurs trop lents de bloquer
1290 un serveur pour les autres utilisateurs.
1291
willy tarreau34f45302006-04-15 21:37:14 +02001292
willy tarreau8f635a42006-05-21 23:05:54 +020012933.5) Abandon des requêtes abortées
1294----------------------------------
1295En présence de très fortes charges, les serveurs mettront un certain temps à
1296répondre. La file d'attente du proxy se remplira, et les temps de réponse
1297suivront une croissance proportionnelle à la taille de file d'attente fois
1298le temps moyen de réponse par session. Lorsque les clients attendront plus de
1299quelques secondes, ils cliqueront souvent sur le bouton 'STOP' de leur
1300navigateur, laissant des requêtes inutiles en file d'attente et ralentissant
1301donc les autres utilisateurs.
1302
1303Comme il n'y a aucun moyen de distinguer un vrai clic sur STOP d'une simple
1304fermeture du canal de sortie sur le client (shutdown(SHUT_WR)), les agents HTTP
1305doivent être conservateurs et considérer que le client n'a probablement fermé
1306que le canal de sortie en attendant la réponse. Toutefois, ceci introduit des
1307risques de congestion lorsque beaucoup d'utilisateurs font de même, et s'avère
1308aujourd'hui complètement inutile car probablement aucun client ne referme la
1309session en attendant la réponse. Certains agents HTTP supportent ceci (Squid,
1310Apache, HAProxy), et d'autres ne le supportent pas (TUX, et la plupart des
1311répartiteurs de charge matériels). Donc la probabilité pour qu'une notification
1312de fermeture d'un canal d'entrée côté client représente un utilisateur cliquant
1313sur 'STOP' est proche de 100%, et il est vraiment tentant d'abandonner la
1314requête prématurément sans polluer les serveurs.
1315
1316Pour cette raison, une nouvelle option "abortonclose" a été introduite en
1317version 1.2.14. Par défaut (sans l'option), le comportement reste conforme à
1318HTTP. Mais lorsque l'option est spécifiée, une session dont le canal entrant
1319est fermé sera abortée si cela est possible, c'est à dire que la requête est
1320soit en file d'attente, soit en tentative de connexion. Ceci réduit
1321considérablement la longueur des files d'attentes et la charge sur les serveurs
1322saturés lorsque les utilisateurs sont tentés de cliquer sur 'STOP', ce qui à
1323son tour, réduit les temps de réponse pour les autres utilisateurs.
1324
1325Exemple :
1326---------
1327 listen web_appl 0.0.0.0:80
1328 maxconn 10000
1329 mode http
1330 cookie SERVERID insert nocache indirect
1331 balance roundrobin
1332 server web1 192.168.1.1:80 cookie s1 weight 10 maxconn 100 check
1333 server web2 192.168.1.2:80 cookie s2 weight 10 maxconn 100 check
1334 server web3 192.168.1.3:80 cookie s3 weight 10 maxconn 100 check
1335 server bck1 192.168.2.1:80 cookie s4 check maxconn 200 backup
1336 option abortonclose
1337
1338
willy tarreauc29948c2005-12-17 13:10:27 +010013394) Fonctionnalités additionnelles
1340=================================
1341
1342D'autres fonctionnalités d'usage moins courant sont disponibles. Il s'agit
willy tarreau8f635a42006-05-21 23:05:54 +02001343principalement du mode transparent, de la journalisation des connexions, de la
1344réécriture des en-têtes, et du statut sous forme de page HTML.
1345
willy tarreau5cbea6f2005-12-17 12:48:26 +01001346
willy tarreau0174f312005-12-18 01:02:42 +010013474.1) Fonctionnalités réseau
1348---------------------------
13494.1.1) Fonctionnement en mode transparent
willy tarreauc29948c2005-12-17 13:10:27 +01001350---------------------------------------
willy tarreau64a3cc32005-12-18 01:13:11 +01001351En mode HTTP, le mot clé 'transparent' permet d'intercepter des sessions
1352routées à travers la machine hébergeant le proxy. Dans ce mode, on ne précise
1353pas l'adresse de répartition 'dispatch', car celle-ci est tirée de l'adresse
willy tarreauc29948c2005-12-17 13:10:27 +01001354destination de la session détournée. Le système doit permettre de rediriger les
1355paquets vers un processus local.
willy tarreau5cbea6f2005-12-17 12:48:26 +01001356
1357Exemple :
willy tarreauc29948c2005-12-17 13:10:27 +01001358---------
willy tarreau5cbea6f2005-12-17 12:48:26 +01001359 listen http_proxy 0.0.0.0:65000
willy tarreauc5f73ed2005-12-18 01:26:38 +01001360 mode http
1361 transparent
1362 cookie SERVERID
1363 server server01 192.168.1.1:80
1364 server server02 192.168.1.2:80
willy tarreau5cbea6f2005-12-17 12:48:26 +01001365
1366 # iptables -t nat -A PREROUTING -i eth0 -p tcp -d 192.168.1.100 \
1367 --dport 80 -j REDIRECT --to-ports 65000
willy tarreau0f7af912005-12-17 12:21:26 +01001368
willy tarreaua41a8b42005-12-17 14:02:24 +01001369Remarque :
1370----------
willy tarreau64a3cc32005-12-18 01:13:11 +01001371Si le port n'est pas spécifié sur le serveur, c'est le port auquel s'est
1372adressé le client qui sera utilisé. Cela permet de relayer tous les ports TCP
1373d'une même adresse avec une même instance et sans utiliser directement le mode
1374transparent.
willy tarreaua41a8b42005-12-17 14:02:24 +01001375
1376Exemple :
1377---------
1378 listen http_proxy 0.0.0.0:65000
willy tarreauc5f73ed2005-12-18 01:26:38 +01001379 mode tcp
1380 server server01 192.168.1.1 check port 60000
1381 server server02 192.168.1.2 check port 60000
willy tarreaua41a8b42005-12-17 14:02:24 +01001382
1383 # iptables -t nat -A PREROUTING -i eth0 -p tcp -d 192.168.1.100 \
1384 -j REDIRECT --to-ports 65000
1385
willy tarreau0174f312005-12-18 01:02:42 +01001386
13874.1.2) Choix d'une adresse source par serveur
1388---------------------------------------------------
1389Avec les versions 1.1.30 et 1.2.3, il devient possible de spécifier une adresse
1390IP source pour joindre chaque serveur. C'est utile pour joindre des serveurs de
1391backup à partir d'un LAN différent, ou pour utiliser des chemins alternatifs
1392pour joindre le même serveur. C'est également utilisable pour faciliter une
1393répartition de charge selon l'adresse IP source pour des connexions sortantes.
1394Bien entendu, la même adresse est utilisée pour les health-checks.
1395
1396Exemple :
1397---------
1398 # utiliser une adresse particulière pour joindre les 2 serveur
1399 listen http_proxy 0.0.0.0:65000
1400 mode http
1401 balance roundrobin
1402 server server01 192.168.1.1:80 source 192.168.2.13
1403 server server02 192.168.1.2:80 source 192.168.2.13
1404
1405Exemple :
1406---------
1407 # utiliser une adresse particulière pour joindre chaque serveur
1408 listen http_proxy 0.0.0.0:65000
1409 mode http
1410 balance roundrobin
1411 server server01 192.168.1.1:80 source 192.168.1.1
1412 server server02 192.168.2.1:80 source 192.168.2.1
1413
1414Exemple :
1415---------
1416 # faire une répartition d'adresse sources pour joindre le même proxy à
1417 # travers deux liens WAN
1418 listen http_proxy 0.0.0.0:65000
1419 mode http
1420 balance roundrobin
1421 server remote-proxy-way1 192.168.1.1:3128 source 192.168.2.1
1422 server remote-proxy-way2 192.168.1.1:3128 source 192.168.3.1
1423
1424Exemple :
1425---------
1426 # forcer une connexion TCP à s'attacher à un port particulier
1427 listen http_proxy 0.0.0.0:2000
1428 mode tcp
1429 balance roundrobin
1430 server srv1 192.168.1.1:80 source 192.168.2.1:20
1431 server srv2 192.168.1.2:80 source 192.168.2.1:20
1432
willy tarreaub952e1d2005-12-18 01:31:20 +010014334.1.3) Maintien de session TCP (keep-alive)
1434-------------------------------------------
1435Avec la version 1.2.7, il devient possible d'activer le maintien de session
1436TCP (TCP keep-alive) à la fois côté client et côté serveur. Cela permet
1437d'empêcher des sessions longues d'expirer sur des équipements de niveau 4
1438externes tels que des firewalls ou des répartiteurs de charge. Cela permet
1439aussi au système de détecter et terminer des sessions figées lorsqu'aucun
1440time-out n'a été positionné (fortement déconseillé). Le proxy ne peut pas
1441positionner l'intervalle entre les annonces ni le nombre maximal, veuillez
1442vous référer au manuel du système d'exploitation pour cela. Il existe 3 options
1443pour activer le maintien de session TCP :
1444
1445 option tcpka # active le keep-alive côté client et côté serveur
1446 option clitcpka # active le keep-alive côté client
1447 option srvtcpka # active le keep-alive côté serveur
1448
willy tarreau0f7af912005-12-17 12:21:26 +01001449
willy tarreauc29948c2005-12-17 13:10:27 +010014504.2) Journalisation des connexions
1451----------------------------------
willy tarreauc5f73ed2005-12-18 01:26:38 +01001452
1453L'un des points forts de HAProxy est indéniablement la précision de ses logs.
1454Il fournit probablement le plus fin niveau d'information disponible pour un
1455tel outil, ce qui est très important pour les diagnostics en environnements
1456complexes. En standard, les informations journalisées incluent le port client,
1457les chronométrages des états TCP/HTTP, des états de session précis au moment de
1458la terminaison et sa cause, des informations sur les décisions d'aiguillage du
1459trafic vers un serveur, et bien sûr la possibilité de capturer des en-têtes
1460arbitraires.
1461
1462Dans le but d'améliorer la réactivité des administrateurs, il offre une grande
1463transparence sur les problèmes rencontrés, à la fois internes et externes, et
1464il est possible d'envoyer les logs vers des serveurs différents en même temps
1465avec des niveaux de filtrage différents :
1466
1467 - logs globaux au niveau processus (erreurs système, arrêts/démarrages, ...)
1468 - erreurs système et internes par instance (manque de ressources, bugs, ...)
1469 - problèmes externes par instance (arrêts/relance serveurs, limites, ...)
1470 - activité par instance (connexions clients), aussi bien lors de leur
1471 établissement qu'à leur terminaison.
1472
1473La possibilité de distribuer différents niveaux de logs à différents serveurs
1474permet à plusieurs équipes de production d'intéragir et de corriger leurs
1475problèmes le plus tôt possible. Par exemple, l'équipe système peut surveiller
1476occasionnellement les erreurs système, pendant que l'équipe application
1477surveille les alertes d'arrêts/démarrages de ses serveurs en temps réel, et
1478que l'équipe sécurité analyse l'activité en différé d'une heure.
1479
1480
willy tarreauc1cae632005-12-17 14:12:23 +010014814.2.1) Niveaux de log
1482---------------------
willy tarreauc29948c2005-12-17 13:10:27 +01001483Les connexions TCP et HTTP peuvent donner lieu à une journalisation sommaire ou
1484détaillée indiquant, pour chaque connexion, la date, l'heure, l'adresse IP
1485source, le serveur destination, la durée de la connexion, les temps de réponse,
willy tarreau8337c6b2005-12-17 13:41:01 +01001486la requête HTTP, le code de retour, la quantité de données transmises, et même
1487dans certains cas, la valeur d'un cookie permettant de suivre les sessions.
1488Tous les messages sont envoyés en syslog vers un ou deux serveurs. Se référer à
1489la section 1.1 pour plus d'information sur les catégories de logs. La syntaxe
willy tarreauc29948c2005-12-17 13:10:27 +01001490est la suivante :
willy tarreau0f7af912005-12-17 12:21:26 +01001491
willy tarreau8337c6b2005-12-17 13:41:01 +01001492 log <adresse_ip_1> <catégorie_1> [niveau_max_1]
1493 log <adresse_ip_2> <catégorie_2> [niveau_max_2]
willy tarreauc29948c2005-12-17 13:10:27 +01001494ou
1495 log global
1496
1497Remarque :
1498----------
1499La syntaxe spécifique 'log global' indique que l'on souhaite utiliser les
1500paramètres de journalisation définis dans la section 'global'.
willy tarreau0f7af912005-12-17 12:21:26 +01001501
1502Exemple :
1503---------
1504 listen http_proxy 0.0.0.0:80
willy tarreauc5f73ed2005-12-18 01:26:38 +01001505 mode http
1506 log 192.168.2.200 local3
1507 log 192.168.2.201 local4
willy tarreau0f7af912005-12-17 12:21:26 +01001508
willy tarreauc1cae632005-12-17 14:12:23 +010015094.2.2) Format des logs
1510----------------------
1511Par défaut, les connexions sont journalisées au niveau TCP dès l'établissement
1512de la session entre le client et le relais. En précisant l'option 'tcplog',
1513la connexion ne sera journalisée qu'en fin de session, ajoutant des précisions
1514sur son état lors de la déconnexion, ainsi que le temps de connexion et la
willy tarreau532bb552006-05-13 18:40:37 +02001515durée totale de la session. Le nombre de sessions restantes après la
1516déconnexion est également indiqué (pour le serveur, l'instance et le process).
willy tarreauc1cae632005-12-17 14:12:23 +01001517
willy tarreauc5f73ed2005-12-18 01:26:38 +01001518Exemple de journalisation TCP :
1519-------------------------------
willy tarreau982249e2005-12-18 00:57:06 +01001520 listen relais-tcp 0.0.0.0:8000
willy tarreauc5f73ed2005-12-18 01:26:38 +01001521 mode tcp
1522 option tcplog
1523 log 192.168.2.200 local3
willy tarreau982249e2005-12-18 00:57:06 +01001524
willy tarreau532bb552006-05-13 18:40:37 +02001525>>> haproxy[18989]: 127.0.0.1:34550 [15/Oct/2003:15:24:28] relais-tcp Srv1 0/0/5007 0 -- 1/1/1 0/0
willy tarreauc5f73ed2005-12-18 01:26:38 +01001526
willy tarreau532bb552006-05-13 18:40:37 +02001527 Champ Format / Description Exemple
1528
1529 1 nom_processus '[' pid ']:' haproxy[18989]:
1530 2 ip_client ':' port_client 127.0.0.1:34550
1531 3 '[' date ']' [15/Oct/2003:15:24:28]
1532 4 nom_instance relais-tcp
1533 5 nom_serveur Srv1
1534 6 temps_file '/' temps_connect '/' temps_total 0/0/5007
1535 7 octets lus 0
1536 8 etat_terminaison --
1537 9 conn_srv '/' conns_inst '/' conns_processus 1/1/1
1538 10 position en file d'attente srv '/' globale 0/0
willy tarreau982249e2005-12-18 00:57:06 +01001539
willy tarreauc1cae632005-12-17 14:12:23 +01001540Une autre option, 'httplog', fournit plus de détails sur le protocole HTTP,
1541notamment la requête et l'état des cookies. Dans les cas où un mécanisme de
1542surveillance effectuant des connexions et déconnexions fréquentes, polluerait
1543les logs, il suffit d'ajouter l'option 'dontlognull', pour ne plus obtenir une
1544ligne de log pour les sessions n'ayant pas donné lieu à un échange de données
1545(requête ou réponse).
willy tarreauc29948c2005-12-17 13:10:27 +01001546
willy tarreauc5f73ed2005-12-18 01:26:38 +01001547Exemple de journalisation HTTP :
1548--------------------------------
willy tarreau036e1ce2005-12-17 13:46:33 +01001549 listen http_proxy 0.0.0.0:80
willy tarreauc5f73ed2005-12-18 01:26:38 +01001550 mode http
1551 option httplog
1552 option dontlognull
1553 log 192.168.2.200 local3
1554
willy tarreau532bb552006-05-13 18:40:37 +02001555>>> haproxy[674]: 127.0.0.1:33319 [15/Oct/2003:08:31:57] relais-http Srv1 9/0/7/147/723 200 243 - - ---- 2/3/3 0/0 "HEAD / HTTP/1.0"
willy tarreauc5f73ed2005-12-18 01:26:38 +01001556
1557Exemple plus complet :
willy tarreau036e1ce2005-12-17 13:46:33 +01001558
willy tarreau532bb552006-05-13 18:40:37 +02001559 haproxy[18989]: 10.0.0.1:34552 [15/Oct/2003:15:26:31] relais-http Srv1 3183/-1/-1/-1/11215 503 0 - - SC-- 137/202/205 0/0 {w.ods.org|Mozilla} {} "HEAD / HTTP/1.0"
willy tarreauc5f73ed2005-12-18 01:26:38 +01001560
willy tarreau532bb552006-05-13 18:40:37 +02001561 Champ Format / Description Exemple
1562
1563 1 nom_processus '[' pid ']:' haproxy[18989]:
1564 2 ip_client ':' port_client 10.0.0.1:34552
1565 3 '[' date ']' [15/Oct/2003:15:26:31]
1566 4 nom_instance relais-http
1567 5 nom_serveur Srv1
1568 6 Tq '/' Tw '/' Tc '/' Tr '/' Tt 3183/-1/-1/-1/11215
1569 7 Code_retour_HTTP 503
1570 8 octets lus 0
1571 9 cookies_requête_capturés -
1572 10 cookies_reponse_capturés -
1573 11 etat_terminaison SC--
1574 12 conns_srv '/' conns_inst '/' conns_processus 137/202/205
1575 13 position file serveur '/' globale 0/0
1576 14 '{' entetes_requête_capturés '}' {w.ods.org|Mozilla}
1577 15 '{' entetes_reponse_capturés '}' {}
1578 16 '"' requête_HTTP '"' "HEAD / HTTP/1.0"
willy tarreauc5f73ed2005-12-18 01:26:38 +01001579
1580Note pour les analyseurs de logs : l'URI est TOUJOURS le dernier champ de la ligne, et
1581 commence par un guillemet '"'.
willy tarreau982249e2005-12-18 00:57:06 +01001582
1583Le problème de loguer uniquement en fin de session, c'est qu'il est impossible
1584de savoir ce qui se passe durant de gros transferts ou des sessions longues.
1585Pour pallier à ce problème, une nouvelle option 'logasap' a été introduite dans
willy tarreau64a3cc32005-12-18 01:13:11 +01001586la version 1.1.28 (1.2.1). Lorsqu'elle est activée, le proxy loguera le plus
1587tôt possible, c'est à dire juste avant que ne débutent les transferts de
1588données. Cela signifie, dans le cas du TCP, qu'il loguera toujours le résultat
1589de la connexion vers le serveur, et dans le cas HTTP, qu'il loguera en fin de
willy tarreauc5f73ed2005-12-18 01:26:38 +01001590traitement des en-têtes de la réponse du serveur, auquel cas le nombre d'octets
1591représentera la taille des en-têtes retournés au client.
willy tarreau982249e2005-12-18 00:57:06 +01001592
willy tarreau64a3cc32005-12-18 01:13:11 +01001593Afin d'éviter toute confusion avec les logs normaux, le temps total de
1594transfert et le nombre d'octets transférés sont préfixés d'un signe '+'
willy tarreauc5f73ed2005-12-18 01:26:38 +01001595rappelant que les valeurs réelles sont certainement plus élevées.
willy tarreau982249e2005-12-18 00:57:06 +01001596
1597Exemple :
1598---------
1599
1600 listen http_proxy 0.0.0.0:80
willy tarreauc5f73ed2005-12-18 01:26:38 +01001601 mode http
1602 option httplog
1603 option dontlognull
1604 option logasap
1605 log 192.168.2.200 local3
willy tarreau982249e2005-12-18 00:57:06 +01001606
willy tarreauc5f73ed2005-12-18 01:26:38 +01001607>>> haproxy[674]: 127.0.0.1:33320 [15/Oct/2003:08:32:17] relais-http Srv1 9/7/14/+30 200 +243 - - ---- 3/3 "GET /image.iso HTTP/1.0"
willy tarreau982249e2005-12-18 00:57:06 +01001608
1609
willy tarreauc1cae632005-12-17 14:12:23 +010016104.2.3) Chronométrage des événements
1611-----------------------------------
1612Pour déceler des problèmes réseau, les mesures du temps écoulé entre certains
1613événements sont d'une très grande utilité. Tous les temps sont mesurés en
1614millisecondes (ms). En mode HTTP, quatre points de mesure sont rapportés sous
willy tarreau532bb552006-05-13 18:40:37 +02001615la forme Tq/Tw/Tc/Tr/Tt :
willy tarreauc1cae632005-12-17 14:12:23 +01001616
1617 - Tq: temps total de réception de la requête HTTP de la part du client.
1618 C'est le temps qui s'est écoulé entre le moment où le client a établi
1619 sa connexion vers le relais, et le moment où ce dernier a reçu le dernier
1620 en-tête HTTP validant la fin de la requête. Une valeur '-1' ici indique
1621 que la requête complète n'a jamais été reçue.
1622
willy tarreau532bb552006-05-13 18:40:37 +02001623 - Tw: temps total passé dans les files d'attente avant d'obtenir une place
1624 vers un serveur. Ceci tient compte à la fois de la file d'attente globale
1625 et de celle du serveur, et dépend du nombre de requêtes dans la file et du
1626 temps nécessaire au serveur pour compléter les sessions précédentes. La
1627 valeur '-1' indique que la requête a été détruite avant d'atteindre une
1628 file.
1629
willy tarreauc1cae632005-12-17 14:12:23 +01001630 - Tc: temps d'établissement de la connexion TCP du relais vers le serveur.
1631 C'est le temps écoulé entre le moment ou le relais a initié la demande de
1632 connexion vers le serveur, et le moment où ce dernier l'a acquittée, c'est
1633 à dire le temps entre l'envoi du paquet TCP SYN la réception du SYN/ACK.
1634 Une valeur '-1' ici indique que la connexion n'a jamais pu être établie
1635 vers le serveur.
1636
1637 - Tr: temps de réponse du serveur. C'est le temps que le serveur a mis pour
willy tarreauc5f73ed2005-12-18 01:26:38 +01001638 renvoyer la totalité des en-têtes HTTP à partir du moment où il a acquitté
willy tarreauc1cae632005-12-17 14:12:23 +01001639 la connexion. Ca représente exactement le temps de traitement de la
1640 transaction sans le transfert des données associées. Une valeur '-1'
willy tarreauc5f73ed2005-12-18 01:26:38 +01001641 indique que le serveur n'a pas envoyé la totalité de l'en-tête HTTP.
willy tarreauc1cae632005-12-17 14:12:23 +01001642
1643 - Tt: durée de vie totale de la session, entre le moment où la demande de
1644 connexion du client a été acquittée et le moment où la connexion a été
willy tarreau982249e2005-12-18 00:57:06 +01001645 refermée aux deux extrémités (client et serveur). La signification change
1646 un peu si l'option 'logasap' est présente. Dans ce cas, le temps correspond
willy tarreau532bb552006-05-13 18:40:37 +02001647 uniquement à (Tq + Tw + Tc + Tr), et se trouve préfixé d'un signe '+'. On
1648 peut donc déduire Td, le temps de transfert des données, en excluant les
1649 autres temps :
willy tarreauc1cae632005-12-17 14:12:23 +01001650
willy tarreau532bb552006-05-13 18:40:37 +02001651 Td = Tt - (Tq + Tw + Tc + Tr)
willy tarreauc1cae632005-12-17 14:12:23 +01001652
1653 Les temps rapportés à '-1' sont simplement à éliminer de cette équation.
1654
willy tarreau532bb552006-05-13 18:40:37 +02001655En mode TCP ('option tcplog'), seuls les deux indicateurs Tw, Tc et Tt sont
willy tarreauc1cae632005-12-17 14:12:23 +01001656rapportés.
1657
1658Ces temps fournissent de précieux renseignement sur des causes probables de
1659problèmes. Du fait que le protocole TCP définisse des temps de retransmission
1660de 3 secondes, puis 6, 12, etc..., l'observation de temps proches de multiples
1661de 3 secondes indique pratiquement toujours des pertes de paquets liés à un
1662problème réseau (câble ou négociation). De plus, si <Tt> est proche d'une
1663valeur de time-out dans la configuration, c'est souvent qu'une session a été
1664abandonnée sur expiration d'un time-out.
1665
1666Cas les plus fréquents :
1667
1668 - Si Tq est proche de 3000, un paquet a très certainement été perdu entre
1669 le client et le relais.
1670 - Si Tc est proche de 3000, un paquet a très certainement été perdu entre
1671 le relais et le serveur durant la phase de connexion. Cet indicateur
1672 devrait normalement toujours être très bas (moins de quelques dizaines).
1673 - Si Tr est presque toujours inférieur à 3000, et que certaines valeurs
1674 semblent proches de la valeur moyenne majorée de 3000, il y a peut-être
1675 de pertes entre le relais et le serveur.
1676 - Si Tt est légèrement supérieur au time-out, c'est souvent parce que le
1677 client et le serveur utilisent du keep-alive HTTP entre eux et que la
1678 session est maintenue après la fin des échanges. Voir plus loin pour
1679 savoir comment désactiver le keep-alive HTTP.
1680
1681Autres cas ('xx' représentant une valeur quelconque à ignorer) :
willy tarreau532bb552006-05-13 18:40:37 +02001682 -1/xx/xx/xx/Tt: le client n'a pas envoyé sa requête dans le temps imparti ou
willy tarreauc5f73ed2005-12-18 01:26:38 +01001683 a refermé sa connexion sans compléter la requête.
willy tarreau532bb552006-05-13 18:40:37 +02001684 Tq/-1/xx/xx/Tt: Il n'était pas possible de traiter la request, probablement
1685 parce que tous les serveurs étaient hors d'usage.
1686 Tq/Tw/-1/xx/Tt: la connexion n'a pas pu s'établir vers le serveur (refus ou
1687 time-out au bout de Tt-(Tq+Tw) ms).
1688 Tq/Tw/Tc/-1/Tt: le serveur a accepté la connexion mais n'a pas répondu dans
willy tarreauc5f73ed2005-12-18 01:26:38 +01001689 les temps ou bien a refermé sa connexion trop tôt, au bout
willy tarreau532bb552006-05-13 18:40:37 +02001690 de Tt-(Tq+Tw+Tc) ms.
willy tarreauc1cae632005-12-17 14:12:23 +01001691
16924.2.4) Conditions de déconnexion
1693--------------------------------
willy tarreauc5f73ed2005-12-18 01:26:38 +01001694Les logs TCP et HTTP fournissent un indicateur de complétude de la session dans
1695le champ 'etat_terminaison', juste avant le nombre de connexions actives. C'est
1696un champ long de 2 caractères en TCP et de 4 caractères en HTTP, chacun ayant
1697une signification précise :
1698
1699 - sur le premier caractère, un code précisant le premier événement qui a causé
1700 la terminaison de la session :
1701
1702 C : fermeture inattendue de la session TCP de la part du client.
1703
1704 S : fermeture inattendue de la session TCP de la part du serveur, ou
1705 refus explicite de connexion de la part de ce dernier.
1706
1707 P : terminaison prématurée des sessions par le proxy, pour cause
1708 d'imposition d'une limite sur le nombre de connexions, pour cause
1709 de configuration (ex: filtre d'URL), ou parce qu'un contrôle de
1710 sécurité a détecté et bloqué une anomalie dans la réponse du
1711 serveur qui aurait pu causer une fuite d'informations (par exemple,
1712 un cookie cachable).
willy tarreau036e1ce2005-12-17 13:46:33 +01001713
willy tarreauc5f73ed2005-12-18 01:26:38 +01001714 R : une ressource sur le proxy a été épuisée (mémoire, sockets, ports
1715 source, ...). Généralement, cela arrive au cours de l'établissement
1716 d'une connexion, et les logs système doivent contenir une copie de
1717 l'érreur précise.
willy tarreau036e1ce2005-12-17 13:46:33 +01001718
willy tarreauc5f73ed2005-12-18 01:26:38 +01001719 I : une erreur interne a été identifiée par le proxy à la suite d'un
1720 auto-contrôle. Ceci ne doit JAMAIS arriver, et vous êtes encouragés
1721 à remonter n'importe quel log contenant ceci car il s'agira un bug.
willy tarreau036e1ce2005-12-17 13:46:33 +01001722
willy tarreauc5f73ed2005-12-18 01:26:38 +01001723 c : le délai maximal d'attente du client a expiré (clitimeout).
1724
1725 s : le délai maximal d'attente du serveur a expiré (srvtimeout et contimeout)
1726
1727 - : terminaison normale de session.
1728
1729 - sur le second caractère, l'état d'avancement de la session TCP/HTTP lors de
1730 la fermeture :
1731
1732 R : attente d'une REQUETE HTTP complète de la part du client. Rien n'a
1733 été transmis au serveur.
1734
willy tarreau532bb552006-05-13 18:40:37 +02001735 Q : attente en file d'attente (QUEUE) d'une place pour avoir une
1736 connexion vers un serveur. Ne peut apparaître que sur un serveur
1737 possédant un paramètre 'maxconn'. Aucune connexion n'a été envoyée
1738 au serveur.
1739
willy tarreauc5f73ed2005-12-18 01:26:38 +01001740 C : attente de l'établissement d'une CONNEXION vers le serveur. Le
1741 serveur peut au plus avoir vu la tentative de connexion, mais
1742 aucune donnée n'a été échangée.
1743
1744 H : attente, réception ou traitement des en-têtes HTTP ("HEADERS").
1745
1746 D : transfert des DONNEES du serveur vers le client.
1747
1748 L : transfert des dernières ("LAST") données du proxy vers le client,
1749 alors que le serveur a déjà fini.
1750
1751 - : terminaison normale, après fin de transfert des données.
willy tarreau036e1ce2005-12-17 13:46:33 +01001752
1753 - le troisième caractère indique l'éventuelle identification d'un cookie de
willy tarreauc1cae632005-12-17 14:12:23 +01001754 persistence (uniquement en mode HTTP) :
willy tarreau036e1ce2005-12-17 13:46:33 +01001755
willy tarreauc5f73ed2005-12-18 01:26:38 +01001756 N : aucun cookie de persistence n'a été présenté. C'est généralement le
1757 cas sur les NOUVELLES connexions clients.
1758
1759 I : le client a présenté un cookie INVALIDE ne correspondant à aucun
1760 serveur connu. Ceci peut être dû à un changement de configuration
1761 récent, à des mélanges de noms de cookies entre sites HTTP/HTTPS,
1762 ou à une attaque.
willy tarreau036e1ce2005-12-17 13:46:33 +01001763
willy tarreauc5f73ed2005-12-18 01:26:38 +01001764 D : le client a présenté un cookie correspondant à un serveur hors
1765 d'usage ("DOWN"). Suivant l'option 'persist', il a été renvoyé vers
1766 un autre serveur ou a tout de même tenté de se connecter sur celui
1767 correspondant au cookie.
willy tarreau036e1ce2005-12-17 13:46:33 +01001768
willy tarreauc5f73ed2005-12-18 01:26:38 +01001769 V : le client a présenté un cookie VALIDE et a pu se connecter au
1770 serveur correspondant.
1771
1772 - : non appliquable (pas de cookie positionné dans la configuration).
1773
1774 - le dernier caractère indique l'éventuel traitement effectué sur un cookie de
1775 persistence retrourné par le serveur (uniquement en mode HTTP) :
1776
1777 N : aucun cookie de persistance n'a été fourni par le serveur, et aucun
1778 n'a été inséré.
1779
1780 I : aucun cookie de persistance n'a été fourni par le serveur, et le
1781 proxy en a INSERE un.
1782
willy tarreau197e8ec2005-12-17 14:10:59 +01001783 P : un cookie de persistence a été fourni par le serveur et transmis
willy tarreauc5f73ed2005-12-18 01:26:38 +01001784 tel quel ("PASSIF").
1785
1786 R : le cookie retourné par le serveur a été REECRIT par le proxy.
1787
1788 D : le cookie présenté par le serveur a été DETRUIT par le proxy pour
1789 ne pas être retourné au client.
1790
1791 - : non appliquable
1792
1793
1794La combinaison des deux premiers indicateurs fournit une grande quantitié
1795d'informations sur ce qui se passait lorsque la session s'est terminée. Cela
1796peut notamment aider à détecter une saturation de serveur, des troubles réseau,
1797des épuisements de ressources système locales, des attaques, etc...
willy tarreau036e1ce2005-12-17 13:46:33 +01001798
willy tarreauc5f73ed2005-12-18 01:26:38 +01001799Les combinaisons d'indicateurs les plus fréquentes sont énumérées ici.
1800
1801 Indic Raison
1802 CR Le client a abandonné avant d'émettre une requête complète. Il est
1803 très probable que la requête ait été tapée à la main dans un client
1804 telnet et abortée trop tôt.
1805
1806 cR Le temps imparti au client a expiré avant réception d'une requête
1807 complète. Ceci est parfois causé par un paramètre TCP MSS trop élevé
1808 sur le client pour des réseaux PPPoE sur ADSL qui ne peuvent pas
1809 transporter des paquets entiers, ou par des clients qui énvoient des
1810 requêtes à la main et ne tapent pas assez vite.
1811
1812 SC Le serveur a explicitement refusé la connexion (le proxy a reçu un
1813 RST TCP ou un message ICMP en retour). Dans certains cas, cela peut
1814 être la couche réseau qui indique au proxy que le serveur n'est pas
1815 joignable (p.ex: pas de route, pas de réponse ARP en local, etc...)
1816
1817 sC La connexion au serveur n'a pas pu s'établir dans le temps imparti.
1818
1819 PC Le proxy a refusé d'établir une connexion au serveur parce que le
1820 nombre de connexions a atteint la limite 'maxconn' (global ou de
1821 l'instance). Le paramètre 'maxconn' de l'instance pourrait être
1822 augmenté, tout comme le paramètre 'maxconn' global.
1823
1824 RC Une ressource locale a été épuisée (mémoire, sockets, ports source),
1825 empêchant la connexion au serveur de s'établir. Les logs d'erreurs
1826 diront précisément ce qui manquait. Dans tous les cas, le seul remède
1827 consiste à affiner le paramétrage système.
1828
1829 cH Le temps imparti au client a expiré au cours d'une requête POST. Ceci
1830 est parfois causé par un paramètre TCP MSS trop élevé sur le client
1831 pour des réseaux PPPoE sur ADSL qui ne peuvent pas transporter des
1832 paquets entiers.
1833
willy tarreau078c79a2006-05-13 12:23:58 +02001834 CH Le client a abandonné alors qu'il attendait un début de réponse de la
1835 part du serveur. Cela peut être causé par le serveur qui mettait trop
1836 de temps à répondre, ou par un client cliquant précipitamment sur le
1837 bouton 'Stop'.
1838
1839 CQ Le client a abandonné alors que sa session était mise en file
1840 d'attente pour obtenir un serveur avec suffisamment de connexions
1841 libres pour l'accepter. Cela signifie soit que l'ensemble des
1842 serveurs étaient saturés, soit que le serveur assigné a mis trop de
1843 temps à répondre.
1844
1845 sQ La session a attendu trop longtemps en file d'attente et a été
1846 expirée.
1847
willy tarreauc5f73ed2005-12-18 01:26:38 +01001848 SH Le serveur a aborté brutalement alors qu'il devait envoyer ses
1849 en-têtes. En général, cela indique qu'il a crashé.
1850
1851 sH Le serveur n'a pas pu répondre durant le temps imparti, ce qui montre
1852 des transactions trop longues, probablement causées par un back-end
1853 saturé. Les seules solutions sont de corriger le problème sur
1854 l'application, d'accroître le paramètre 'srvtimeout' pour supporter
1855 des attentes plus longues au risque que les clients abandonnent à
1856 leur tour, ou bien d'ajouter des serveurs.
1857
1858 PR Le proxy a bloqué une requête du client, soit à cause d'une syntaxe
1859 HTTP invalide, auquel cas il a renvoyé une erreur HTTP 400 au client,
1860 soit à cause d'une requête validant un filtre d'interdiction, auquel
1861 cas le proxy a renvoyé une erreur HTTP 403.
1862
1863 PH Le proxy a bloqué la réponse du serveur parce qu'elle était invalide,
1864 incomplète, dangereuse ('cache control'), ou parce qu'elle validait
1865 un filtre de sécurité. Dans tous les cas, une erreur HTTP 502 est
1866 renvoyée au client.
1867
1868 cD Le client n'a pas lu de données pendant le temps qui lui était
1869 imparti. Ceci est souvent causé par des problèmes réseau côté client.
1870
1871 CD Le client a aborté sa connection de manière inattendue pendant le
1872 transfert des données. Ceci est provoqué soit par le crash d'un
1873 navigateur, ou par une session en HTTP keep-alive entre le serveur
1874 et le client terminée en premier par le client.
1875
1876 sD Le serveur n'a rien fait durant le temps imparti par le paramètre
1877 'srvtimeout'. Ceci est souvent causé par des timeouts trop courts
1878 sur des équipements de niveau 4 (firewalls, répartiteurs de charge)
1879 situés entre le proxy et le serveur.
1880
18814.2.5) Caractères non-imprimables
1882---------------------------------
1883Depuis la version 1.1.29, les caractères non-imprimables ne sont plus envoyés
1884tels quels dans les lignes de logs, mais inscrits sous la forme de deux chiffres
1885hexadécimaux, préfixés du caractère d'échappement '#'. Les seuls caractères
1886dorénavant logués tels quels sont compris entre 32 et 126. Bien évidemment, le
1887caractère d'échappement '#' est lui-même encodé afin de lever l'ambiguité. Il en
1888est de même pour le caractère '"', ainsi que les caractères '{', '|' et '}' pour
1889les en-têtes.
1890
18914.2.6) Capture d'en-têtes HTTP et de cookies
1892--------------------------------------------
1893La version 1.1.23 a apporté la capture des cookies, et la version 1.1.29 la
1894capture d'en-têtes. Tout ceci est effectué en utilisant le mot-clé 'capture'.
1895
1896Les captures de cookies facilitent le suivi et la reconstitution d'une session
1897utilisateur. La syntaxe est la suivante :
willy tarreau8337c6b2005-12-17 13:41:01 +01001898
1899 capture cookie <préfixe_cookie> len <longueur_capture>
1900
willy tarreauc5f73ed2005-12-18 01:26:38 +01001901Ceci activera la capture de cookies à la fois dans les requêtes et dans les
1902réponses. De cette manière, il devient facile de détecter lorsqu'un utilisateur
1903bascule sur une nouvelle session par exemple, car le serveur lui réassignera un
1904nouveau cookie.
1905
willy tarreau8337c6b2005-12-17 13:41:01 +01001906Le premier cookie dont le nom commencera par <préfixe_cookie> sera capturé, et
1907transmis sous la forme "NOM=valeur", sans toutefois, excéder <longueur_capture>
1908caractères (64 au maximum). Lorsque le nom du cookie est fixe et connu, on peut
1909le suffixer du signe "=" pour s'assurer qu'aucun autre cookie ne prendra sa
1910place dans les logs.
1911
1912Exemples :
1913----------
1914 # capture du premier cookie dont le nom commence par "ASPSESSION"
1915 capture cookie ASPSESSION len 32
1916
1917 # capture du premier cookie dont le nom est exactement "vgnvisitor"
1918 capture cookie vgnvisitor= len 32
1919
willy tarreau036e1ce2005-12-17 13:46:33 +01001920Dans les logs, le champ précédant l'indicateur de complétude contient le cookie
willy tarreau64a3cc32005-12-18 01:13:11 +01001921positionné par le serveur, précédé du cookie positionné par le client. Chacun
1922de ces champs est remplacé par le signe "-" lorsqu'aucun cookie n'est fourni
willy tarreauc5f73ed2005-12-18 01:26:38 +01001923par le client ou le serveur, ou lorsque l'option est désactivée..
1924
1925Les captures d'en-têtes ont un rôle complètement différent. Elles sont utiles
1926pour suivre un identifiant de requête globalement unique positionné par un
1927autre proxy en amont, pour journaliser les noms de serveurs virtuels, les types
1928de clients web, la longueur des POST, les 'referrers', etc. Dans la réponse, on
1929peut chercher des informations relatives à la longueur annoncée de la réponse,
1930le fonctionnement attendu du cache, ou encore la localisation d'un objet en cas
1931de redirection. Tout comme pour les captures de cookies, il est possible
1932d'inclure les en-têtes de requêtes et de réponse simultanément. La syntaxe est
1933la suivante :
1934
1935 capture request header <nom> len <longueur max>
1936 capture response header <nom> len <longueur max>
1937
1938Note: Les noms d'en-têtes ne sont pas sensibles à la casse.
willy tarreau8337c6b2005-12-17 13:41:01 +01001939
willy tarreauc5f73ed2005-12-18 01:26:38 +01001940Exemples:
1941---------
1942 # conserver le nom du serveur virtuel accédé par le client
1943 capture request header Host len 20
1944 # noter la longueur des données envoyées dans un POST
1945 capture request header Content-Length len 10
1946
1947 # noter le fonctionnement attendu du cache par le serveur
1948 capture response header Cache-Control len 8
1949 # noter l'URL de redirection
1950 capture response header Location len 20
1951
1952Les en-têtes non trouvés sont logués à vide, et si un en-tête apparait plusieurs
1953fois, seule la dernière occurence sera conservée. Les en-têtes de requête sont
1954regroupés entre deux accolades '{' et '}' dans l'ordre de leur déclaration, et
1955chacun séparés par une barre verticale '|', sans aucun espace. Les en-têtes de
1956réponse sont présentés de la même manière, mais après un espace suivant le bloc
1957d'en-tête de requête. Le tout précède la requête HTTP. Exemple :
1958
1959 Config:
1960
1961 capture request header Host len 20
1962 capture request header Content-Length len 10
1963 capture request header Referer len 20
1964 capture response header Server len 20
1965 capture response header Content-Length len 10
1966 capture response header Cache-Control len 8
1967 capture response header Via len 20
1968 capture response header Location len 20
1969
1970 Log :
1971
willy tarreau532bb552006-05-13 18:40:37 +02001972 Aug 9 20:26:09 localhost haproxy[2022]: 127.0.0.1:34014 [09/Aug/2004:20:26:09] relais-http netcache 0/0/0/162/+162 200 +350 - - ---- 0/0/0 0/0 {fr.adserver.yahoo.co||http://fr.f416.mail.} {|864|private||} "GET http://fr.adserver.yahoo.com/"
1973 Aug 9 20:30:46 localhost haproxy[2022]: 127.0.0.1:34020 [09/Aug/2004:20:30:46] relais-http netcache 0/0/0/182/+182 200 +279 - - ---- 0/0/0 0/0 {w.ods.org||} {Formilux/0.1.8|3495|||} "GET http://w.ods.org/sytadin.html HTTP/1.1"
1974 Aug 9 20:30:46 localhost haproxy[2022]: 127.0.0.1:34028 [09/Aug/2004:20:30:46] relais-http netcache 0/0/2/126/+128 200 +223 - - ---- 0/0/0 0/0 {www.infotrafic.com||http://w.ods.org/syt} {Apache/2.0.40 (Red H|9068|||} "GET http://www.infotrafic.com/images/live/cartesidf/grandes/idf_ne.png HTTP/1.1"
willy tarreauc5f73ed2005-12-18 01:26:38 +01001975
19764.2.7) Exemples de logs
willy tarreauc1cae632005-12-17 14:12:23 +01001977-----------------------
willy tarreau532bb552006-05-13 18:40:37 +02001978- haproxy[674]: 127.0.0.1:33319 [15/Oct/2003:08:31:57] relais-http Srv1 6559/0/7/147/6723 200 243 - - ---- 1/3/5 0/0"HEAD / HTTP/1.0"
willy tarreauc1cae632005-12-17 14:12:23 +01001979 => requête longue (6.5s) saisie à la main avec un client telnet. Le serveur a
1980 répondu en 147 ms et la session s'est terminée normalement ('----')
willy tarreauc29948c2005-12-17 13:10:27 +01001981
willy tarreau532bb552006-05-13 18:40:37 +02001982- haproxy[674]: 127.0.0.1:33319 [15/Oct/2003:08:31:57] relais-http Srv1 6559/1230/7/147/6870 200 243 - - ---- 99/239/324 0/9 "HEAD / HTTP/1.0"
1983 => Idem, mais la requête a été mise en attente dans la file globale derrière
1984 9 autres requêtes déjà présentes, et y a attendu 1230 ms.
1985
1986- haproxy[674]: 127.0.0.1:33320 [15/Oct/2003:08:32:17] relais-http Srv1 9/0/7/14/+30 200 +243 - - ---- 1/3/3 0/0 "GET /image.iso HTTP/1.0"
willy tarreau982249e2005-12-18 00:57:06 +01001987 => requête pour un long transfert. L'option 'logasap' était spécifiée donc le
1988 log a été généré juste avant le transfert de données. Le serveur a répondu
willy tarreauc5f73ed2005-12-18 01:26:38 +01001989 en 14 ms, 243 octets d'en-têtes ont été transférés au client, et le temps
willy tarreau982249e2005-12-18 00:57:06 +01001990 total entre l'accept() et le premier octet de donnée est de 30 ms.
1991
willy tarreau532bb552006-05-13 18:40:37 +02001992- haproxy[674]: 127.0.0.1:33320 [15/Oct/2003:08:32:17] relais-http Srv1 9/0/7/14/30 502 243 - - PH-- 0/2/3 0/0 "GET /cgi-bin/bug.cgi? HTTP/1.0"
willy tarreau982249e2005-12-18 00:57:06 +01001993 => le proxy a bloqué une réponse du serveur soit à cause d'un filtre 'rspdeny'
1994 ou 'rspideny', soit parce qu'il a détecté un risque de fuite sensible
1995 d'informations risquant d'être cachées. Dans ce cas, la réponse est
1996 remplacée par '502 bad gateway'.
1997
willy tarreau532bb552006-05-13 18:40:37 +02001998- haproxy[18113]: 127.0.0.1:34548 [15/Oct/2003:15:18:55] relais-http <NOSRV> -1/-1/-1/-1/8490 -1 0 - - CR-- 0/2/2 0/0 ""
willy tarreauc1cae632005-12-17 14:12:23 +01001999 => Le client n'a pas envoyé sa requête et a refermé la connexion lui-même
willy tarreauc5f73ed2005-12-18 01:26:38 +01002000 ('C---') au bout de 8.5s, alors que le relais attendait l'en-tête ('-R--').
willy tarreauc1cae632005-12-17 14:12:23 +01002001 Aucune connexion n'a été envoyée vers le serveur.
willy tarreau0f7af912005-12-17 12:21:26 +01002002
willy tarreau532bb552006-05-13 18:40:37 +02002003- haproxy[18113]: 127.0.0.1:34549 [15/Oct/2003:15:19:06] relais-http <NOSRV> -1/-1/-1/-1/50001 408 0 - - cR-- 0/2/2 0/0 ""
willy tarreauc1cae632005-12-17 14:12:23 +01002004 => Le client n'a pas envoyé sa requête et son time-out a expiré ('c---') au
willy tarreauc5f73ed2005-12-18 01:26:38 +01002005 bout de 50s, alors que le relais attendait l'en-tête ('-R--'). Aucune
willy tarreauc1cae632005-12-17 14:12:23 +01002006 connexion n'a été envoyée vers le serveur, mais le relais a tout de même
2007 pu renvoyer un message 408 au client.
2008
willy tarreauc5f73ed2005-12-18 01:26:38 +01002009- haproxy[18989]: 127.0.0.1:34550 [15/Oct/2003:15:24:28] relais-tcp Srv1 0/5007 0 cD
2010 => log en mode 'tcplog'. Expiration du time-out côté client ('cD') au bout de
2011 5s.
willy tarreauc1cae632005-12-17 14:12:23 +01002012
willy tarreau532bb552006-05-13 18:40:37 +02002013- haproxy[18989]: 10.0.0.1:34552 [15/Oct/2003:15:26:31] relais-http Srv1 3183/-1/-1/-1/11215 503 0 - - SC-- 115/202/205 0/0 "HEAD / HTTP/1.0"
willy tarreauc1cae632005-12-17 14:12:23 +01002014 => La requête client met 3s à entrer (peut-être un problème réseau), et la
2015 connexion ('SC--') vers le serveur échoue au bout de 4 tentatives de 2
willy tarreau532bb552006-05-13 18:40:37 +02002016 secondes (retries 3 dans la conf), puis un code 503 est retourné au
2017 client. Il y avait 115 connexions sur ce serveur, 202 connexions sur cette
2018 instance, et 205 sur l'ensemble des instances pour ce processus. Il est
2019 possible que le serveur ait refusé la connexion parce qu'il y en avait
2020 déjà trop d'établies.
willy tarreau4302f492005-12-18 01:00:37 +01002021
willy tarreau4302f492005-12-18 01:00:37 +01002022
willy tarreauc5f73ed2005-12-18 01:26:38 +010020234.3) Modification des en-têtes HTTP
willy tarreauc29948c2005-12-17 13:10:27 +01002024----------------------------------
2025En mode HTTP uniquement, il est possible de remplacer certains en-têtes dans la
2026requête et/ou la réponse à partir d'expressions régulières. Il est également
willy tarreau64a3cc32005-12-18 01:13:11 +01002027possible de bloquer certaines requêtes en fonction du contenu des en-têtes ou
2028de la requête. Une limitation cependant : les en-têtes fournis au milieu de
willy tarreauc29948c2005-12-17 13:10:27 +01002029connexions persistentes (keep-alive) ne sont pas vus car ils sont considérés
2030comme faisant partie des échanges de données consécutifs à la première requête.
2031Les données ne sont pas affectées, ceci ne s'applique qu'aux en-têtes.
willy tarreau0f7af912005-12-17 12:21:26 +01002032
2033La syntaxe est :
willy tarreauc29948c2005-12-17 13:10:27 +01002034 reqadd <string> pour ajouter un en-tête dans la requête
2035 reqrep <search> <replace> pour modifier la requête
2036 reqirep <search> <replace> idem sans distinction majuscules/minuscules
2037 reqdel <search> pour supprimer un en-tête dans la requête
2038 reqidel <search> idem sans distinction majuscules/minuscules
willy tarreauc5f73ed2005-12-18 01:26:38 +01002039 reqallow <search> autoriser la requête si un en-tête valide <search>
willy tarreauc29948c2005-12-17 13:10:27 +01002040 reqiallow <search> idem sans distinction majuscules/minuscules
willy tarreauc5f73ed2005-12-18 01:26:38 +01002041 reqdeny <search> interdire la requête si un en-tête valide <search>
willy tarreau240afa62005-12-17 13:14:35 +01002042 reqideny <search> idem sans distinction majuscules/minuscules
willy tarreauc5f73ed2005-12-18 01:26:38 +01002043 reqpass <search> inhibe ces actions sur les en-têtes validant <search>
willy tarreau036e1ce2005-12-17 13:46:33 +01002044 reqipass <search> idem sans distinction majuscules/minuscules
willy tarreau5cbea6f2005-12-17 12:48:26 +01002045
willy tarreau036e1ce2005-12-17 13:46:33 +01002046 rspadd <string> pour ajouter un en-tête dans la réponse
2047 rsprep <search> <replace> pour modifier la réponse
2048 rspirep <search> <replace> idem sans distinction majuscules/minuscules
2049 rspdel <search> pour supprimer un en-tête dans la réponse
2050 rspidel <search> idem sans distinction majuscules/minuscules
willy tarreau982249e2005-12-18 00:57:06 +01002051 rspdeny <search> remplace la réponse par un HTTP 502 si un
willy tarreauc5f73ed2005-12-18 01:26:38 +01002052 en-tête valide <search>
willy tarreau982249e2005-12-18 00:57:06 +01002053 rspideny <search> idem sans distinction majuscules/minuscules
willy tarreau5cbea6f2005-12-17 12:48:26 +01002054
willy tarreau0f7af912005-12-17 12:21:26 +01002055
willy tarreau036e1ce2005-12-17 13:46:33 +01002056<search> est une expression régulière compatible POSIX regexp supportant le
2057groupage par parenthèses (sans les '\'). Les espaces et autres séparateurs
2058doivent êtres précédés d'un '\' pour ne pas être confondus avec la fin de la
2059chaîne. De plus, certains caractères spéciaux peuvent être précédés d'un
2060backslach ('\') :
willy tarreau5cbea6f2005-12-17 12:48:26 +01002061
2062 \t pour une tabulation
2063 \r pour un retour charriot
2064 \n pour un saut de ligne
2065 \ pour différencier un espace d'un séparateur
2066 \# pour différencier un dièse d'un commentaire
willy tarreau036e1ce2005-12-17 13:46:33 +01002067 \\ pour utiliser un backslash dans la regex
2068 \\\\ pour utiliser un backslash dans le texte
willy tarreau5cbea6f2005-12-17 12:48:26 +01002069 \xXX pour un caractère spécifique XX (comme en C)
willy tarreau0f7af912005-12-17 12:21:26 +01002070
willy tarreau0f7af912005-12-17 12:21:26 +01002071
willy tarreau5cbea6f2005-12-17 12:48:26 +01002072<replace> contient la chaîne remplaçant la portion vérifiée par l'expression.
2073Elle peut inclure les caractères spéciaux ci-dessus, faire référence à un
2074groupe délimité par des parenthèses dans l'expression régulière, par sa
2075position numérale. Les positions vont de 1 à 9, et sont codées par un '\'
2076suivi du chiffre désiré. Il est également possible d'insérer un caractère non
2077imprimable (utile pour le saut de ligne) inscrivant '\x' suivi du code
2078hexadécimal de ce caractère (comme en C).
2079
2080<string> représente une chaîne qui sera ajoutée systématiquement après la
willy tarreauc29948c2005-12-17 13:10:27 +01002081dernière ligne d'en-tête.
willy tarreau5cbea6f2005-12-17 12:48:26 +01002082
2083Remarques :
willy tarreau197e8ec2005-12-17 14:10:59 +01002084-----------
willy tarreau5cbea6f2005-12-17 12:48:26 +01002085 - la première ligne de la requête et celle de la réponse sont traitées comme
willy tarreauc29948c2005-12-17 13:10:27 +01002086 des en-têtes, ce qui permet de réécrire des URL et des codes d'erreur.
willy tarreau5cbea6f2005-12-17 12:48:26 +01002087 - 'reqrep' est l'équivalent de 'cliexp' en version 1.0, et 'rsprep' celui de
2088 'srvexp'. Ces noms sont toujours supportés mais déconseillés.
2089 - pour des raisons de performances, le nombre total de caractères ajoutés sur
willy tarreau535ae7a2005-12-17 12:58:00 +01002090 une requête ou une réponse est limité à 4096 depuis la version 1.1.5 (cette
2091 limite était à 256 auparavant). Cette valeur est modifiable dans le code.
2092 Pour un usage temporaire, on peut gagner de la place en supprimant quelques
willy tarreauc5f73ed2005-12-18 01:26:38 +01002093 en-têtes inutiles avant les ajouts.
willy tarreau982249e2005-12-18 00:57:06 +01002094 - une requête bloquée produira une réponse "HTTP 403 forbidden" tandis qu'une
2095 réponse bloquée produira une réponse "HTTP 502 Bad gateway".
willy tarreau0f7af912005-12-17 12:21:26 +01002096
2097Exemples :
willy tarreau197e8ec2005-12-17 14:10:59 +01002098----------
willy tarreauc5f73ed2005-12-18 01:26:38 +01002099 ###### a few examples ######
willy tarreau197e8ec2005-12-17 14:10:59 +01002100
willy tarreauc5f73ed2005-12-18 01:26:38 +01002101 # rewrite 'online.fr' instead of 'free.fr' for GET and POST requests
2102 reqrep ^(GET\ .*)(.free.fr)(.*) \1.online.fr\3
2103 reqrep ^(POST\ .*)(.free.fr)(.*) \1.online.fr\3
willy tarreau197e8ec2005-12-17 14:10:59 +01002104
willy tarreauc5f73ed2005-12-18 01:26:38 +01002105 # force proxy connections to close
2106 reqirep ^Proxy-Connection:.* Proxy-Connection:\ close
2107 # rewrite locations
2108 rspirep ^(Location:\ )([^:]*://[^/]*)(.*) \1\3
willy tarreau197e8ec2005-12-17 14:10:59 +01002109
willy tarreauc5f73ed2005-12-18 01:26:38 +01002110 ###### A full configuration being used on production ######
willy tarreau0f7af912005-12-17 12:21:26 +01002111
willy tarreau197e8ec2005-12-17 14:10:59 +01002112 # Every header should end with a colon followed by one space.
2113 reqideny ^[^:\ ]*[\ ]*$
2114
2115 # block Apache chunk exploit
2116 reqideny ^Transfer-Encoding:[\ ]*chunked
2117 reqideny ^Host:\ apache-
2118
2119 # block annoying worms that fill the logs...
2120 reqideny ^[^:\ ]*\ .*(\.|%2e)(\.|%2e)(%2f|%5c|/|\\\\)
2121 reqideny ^[^:\ ]*\ ([^\ ]*\ [^\ ]*\ |.*%00)
2122 reqideny ^[^:\ ]*\ .*<script
2123 reqideny ^[^:\ ]*\ .*/(root\.exe\?|cmd\.exe\?|default\.ida\?)
2124
2125 # allow other syntactically valid requests, and block any other method
2126 reqipass ^(GET|POST|HEAD|OPTIONS)\ /.*\ HTTP/1\.[01]$
2127 reqipass ^OPTIONS\ \\*\ HTTP/1\.[01]$
2128 reqideny ^[^:\ ]*\
2129
2130 # force connection:close, thus disabling HTTP keep-alive
willy tarreauc5f73ed2005-12-18 01:26:38 +01002131 option httpclos
willy tarreau197e8ec2005-12-17 14:10:59 +01002132
willy tarreauc5f73ed2005-12-18 01:26:38 +01002133 # change the server name
willy tarreau197e8ec2005-12-17 14:10:59 +01002134 rspidel ^Server:\
2135 rspadd Server:\ Formilux/0.1.8
2136
willy tarreau0f7af912005-12-17 12:21:26 +01002137
willy tarreau982249e2005-12-18 00:57:06 +01002138De plus, l'option 'forwardfor' ajoute l'adresse IP du client dans un champ
willy tarreauc1cae632005-12-17 14:12:23 +01002139'X-Forwarded-For' de la requête, ce qui permet à un serveur web final de
2140connaître l'adresse IP du client initial.
2141
willy tarreau982249e2005-12-18 00:57:06 +01002142Enfin, l'option 'httpclose' apparue dans la version 1.1.28/1.2.1 supprime tout
willy tarreauc5f73ed2005-12-18 01:26:38 +01002143en-tête de type 'Connection:' et ajoute 'Connection: close' dans les deux sens.
willy tarreau982249e2005-12-18 00:57:06 +01002144Ceci simplifie la désactivation du keep-alive HTTP par rapport à l'ancienne
2145méthode impliquant 4 règles.
2146
willy tarreauc1cae632005-12-17 14:12:23 +01002147Exemple :
2148---------
2149 listen http_proxy 0.0.0.0:80
willy tarreauc5f73ed2005-12-18 01:26:38 +01002150 mode http
2151 log global
2152 option httplog
2153 option dontlognull
2154 option forwardfor
2155 option httpclose
willy tarreauc1cae632005-12-17 14:12:23 +01002156
Willy TARREAU767ba712006-03-01 22:40:50 +01002157Notons que certains serveurs HTTP ne referment pas nécessairement la session
2158TCP en fin de traitement lorsqu'ils reçoivent un entête 'Connection: close',
2159ce qui se traduit par des grands nombres de sessions établies et des temps
2160globaux très longs sur les requêtes. Pour contourner ce problème, la version
21611.2.9 apporte une nouvelle option 'forceclose' qui referme la connexion sortant
2162vers le serveur dès qu'il commence à répondre et seulement si le tampon de
2163requête est vide. Attention toutefois à ne PAS utiliser cette option si des
2164méthodes CONNECT sont attendues entre le client et le serveur. L'option
2165'forceclose' implique l'option 'httpclose'.
2166
2167Exemple :
2168---------
2169 listen http_proxy 0.0.0.0:80
2170 mode http
2171 log global
2172 option httplog
2173 option dontlognull
2174 option forwardfor
2175 option forceclose
2176
2177
willy tarreauc29948c2005-12-17 13:10:27 +010021784.4) Répartition avec persistence
2179---------------------------------
willy tarreau5cbea6f2005-12-17 12:48:26 +01002180La combinaison de l'insertion de cookie avec la répartition de charge interne
2181permet d'assurer une persistence dans les sessions HTTP d'une manière
2182pratiquement transparente pour les applications. Le principe est simple :
willy tarreau96d40372005-12-17 13:11:56 +01002183 - attribuer une valeur d'un cookie à chaque serveur
willy tarreau5cbea6f2005-12-17 12:48:26 +01002184 - effectuer une répartition interne
willy tarreau240afa62005-12-17 13:14:35 +01002185 - insérer un cookie dans les réponses issues d'une répartition uniquement,
2186 et faire en sorte que des caches ne mémorisent pas ce cookie.
2187 - cacher ce cookie à l'application lors des requêtes ultérieures.
willy tarreau5cbea6f2005-12-17 12:48:26 +01002188
2189Exemple :
willy tarreau8337c6b2005-12-17 13:41:01 +01002190---------
willy tarreau5cbea6f2005-12-17 12:48:26 +01002191 listen application 0.0.0.0:80
willy tarreauc5f73ed2005-12-18 01:26:38 +01002192 mode http
2193 cookie SERVERID insert nocache indirect
2194 balance roundrobin
2195 server srv1 192.168.1.1:80 cookie server01 check
2196 server srv2 192.168.1.2:80 cookie server02 check
willy tarreau5cbea6f2005-12-17 12:48:26 +01002197
willy tarreau0174f312005-12-18 01:02:42 +01002198L'autre solution apportée par les versions 1.1.30 et 1.2.3 est de réutiliser un
2199cookie en provenance du serveur et de lui préfixer l'identifiant du serveur.
2200Dans ce cas, ne pas oublier de forcer le mode "httpclose" pour empêcher le
2201client et le serveur de travailler en mode "keep-alive" afin que le proxy
2202puisse corriger le nom du cookie dans toutes les futures requêtes.
2203
2204 listen application 0.0.0.0:80
2205 mode http
2206 cookie JSESSIONID prefix
2207 balance roundrobin
willy tarreau598da412005-12-18 01:07:29 +01002208 server srv1 192.168.1.1:80 cookie srv1 check
2209 server srv2 192.168.1.2:80 cookie srv2 check
willy tarreau0174f312005-12-18 01:02:42 +01002210 option httpclose
2211
2212
willy tarreau982249e2005-12-18 00:57:06 +010022134.5) Protection contre les fuites d'informations du serveur
2214-----------------------------------------------------------
willy tarreau64a3cc32005-12-18 01:13:11 +01002215Dans les versions 1.1.28 et 1.2.1, une nouvelle option 'checkcache' a été
willy tarreauc5f73ed2005-12-18 01:26:38 +01002216créée. Elle sert à inspecter minutieusement les en-têtes 'Cache-control',
willy tarreau64a3cc32005-12-18 01:13:11 +01002217'Pragma', et 'Set-cookie' dans les réponses serveur pour déterminer s'il y a
2218un risque de cacher un cookie sur un proxy côté client. Quand cette option est
2219activée, les seules réponses qui peuvent être retournées au client sont :
willy tarreauc5f73ed2005-12-18 01:26:38 +01002220 - toutes celles qui n'ont pas d'en-tête 'Set-cookie' ;
willy tarreau982249e2005-12-18 00:57:06 +01002221 - toutes celles qui ont un code de retour autre que 200, 203, 206, 300, 301,
willy tarreauc5f73ed2005-12-18 01:26:38 +01002222 410, sauf si le serveur a positionné un en-tête 'Cache-control: public' ;
willy tarreau982249e2005-12-18 00:57:06 +01002223 - celles qui font suite à une requête POST, sauf si le serveur a positionné
willy tarreauc5f73ed2005-12-18 01:26:38 +01002224 un en-tête 'Cache-control: public' ;
2225 - celles qui ont un en-tête 'Pragma: no-cache' ;
2226 - celles qui ont un en-tête 'Cache-control: private' ;
2227 - celles qui ont un en-tête 'Cache-control: no-store' ;
2228 - celles qui ont un en-tête 'Cache-control: max-age=0' ;
2229 - celles qui ont un en-tête 'Cache-control: s-maxage=0' ;
2230 - celles qui ont un en-tête 'Cache-control: no-cache' ;
2231 - celles qui ont un en-tête 'Cache-control: no-cache="set-cookie"' ;
2232 - celles qui ont un en-tête 'Cache-control: no-cache="set-cookie,'
willy tarreau982249e2005-12-18 00:57:06 +01002233 (autorisant d'autres champs après set-cookie).
willy tarreau8337c6b2005-12-17 13:41:01 +01002234
willy tarreau982249e2005-12-18 00:57:06 +01002235Si une réponse ne respecte pas ces pré-requis, alors elle sera bloquée de la
2236même manière que s'il s'agissait d'un filtre 'rspdeny', avec en retour un
2237message "HTTP 502 bad gateway". L'état de session montre "PH--" ce qui veut
2238dire que c'est le proxy qui a bloqué la réponse durant le traitement des
willy tarreauc5f73ed2005-12-18 01:26:38 +01002239en-têtes. De plus, un message d'alerte sera envoyé dans les logs de sorte que
willy tarreau982249e2005-12-18 00:57:06 +01002240l'administrateur sache qu'il y a une action correctrice à entreprendre.
2241
22424.6) Personalisation des erreurs
2243--------------------------------
willy tarreau8337c6b2005-12-17 13:41:01 +01002244Certaines situations conduisent à retourner une erreur HTTP au client :
2245 - requête invalide ou trop longue => code HTTP 400
2246 - requête mettant trop de temps à venir => code HTTP 408
2247 - requête interdite (bloquée par un reqideny) => code HTTP 403
2248 - erreur interne du proxy => code HTTP 500
2249 - le serveur a retourné une réponse incomplète ou invalide => code HTTP 502
2250 - aucun serveur disponible pour cette requête => code HTTP 503
2251 - le serveur n'a pas répondu dans le temps imparti => code HTTP 504
2252
2253Un message d'erreur succint tiré de la RFC accompagne ces codes de retour.
2254Cependant, en fonction du type de clientèle, on peut préférer retourner des
willy tarreau64a3cc32005-12-18 01:13:11 +01002255pages personnalisées. Ceci est possible par le biais de la commande "errorloc":
willy tarreau8337c6b2005-12-17 13:41:01 +01002256
2257 errorloc <code_HTTP> <location>
2258
2259Au lieu de générer une erreur HTTP <code_HTTP> parmi les codes cités ci-dessus,
2260le proxy génèrera un code de redirection temporaire (HTTP 302) vers l'adresse
2261d'une page précisée dans <location>. Cette adresse peut être relative au site,
2262ou absolue. Comme cette réponse est traîtée par le navigateur du client
2263lui-même, il est indispensable que l'adresse fournie lui soit accessible.
2264
2265Exemple :
2266---------
2267 listen application 0.0.0.0:80
2268 errorloc 400 /badrequest.html
2269 errorloc 403 /forbidden.html
2270 errorloc 408 /toolong.html
willy tarreauc5f73ed2005-12-18 01:26:38 +01002271 errorloc 500 http://haproxy.domain.net/bugreport.html
willy tarreau8337c6b2005-12-17 13:41:01 +01002272 errorloc 502 http://192.168.114.58/error50x.html
2273 errorloc 503 http://192.168.114.58/error50x.html
2274 errorloc 504 http://192.168.114.58/error50x.html
2275
willy tarreauc1f47532005-12-18 01:08:26 +01002276Note: la RFC2616 stipule qu'un client doit réutiliser la même méthode pour
2277accéder à l'URL de redirection que celle qui l'a retournée, ce qui pose des
2278problèmes avec les requêtes POST. Le code de retour 303 a été créé exprès pour
2279régler ce problème, indiquant au client qu'il doit accéder à l'URL retournée
2280dans le champ Location avec la méthode GET uniquement. Seulement, certains
2281navigateurs antérieurs à HTTP/1.1 ne connaissent pas ce code de retour. De
2282plus, la plupart des navigateurs se comportent déjà avec le code 302 comme ils
2283devraient le faire avec le 303. Donc, dans le but de laisser le choix à
willy tarreauc5f73ed2005-12-18 01:26:38 +01002284l'utilisateur, les versions 1.1.31 et 1.2.5 apportent deux nouvelles commandes
2285visant à remplacer 'errorloc' : 'errorloc302' et 'errorloc303'.
willy tarreauc1f47532005-12-18 01:08:26 +01002286
2287Leur usage non ambigü est recommandé à la place de la commande 'errorloc' (qui
2288utilise toujours 302). Dans le doute, préférez l'utilisation de 'errorloc303'
2289dès que vous savez que vos clients supportent le code de retour HTTP 303.
2290
willy tarreau982249e2005-12-18 00:57:06 +010022914.7) Changement des valeurs par défaut
willy tarreaua41a8b42005-12-17 14:02:24 +01002292--------------------------------------
willy tarreau64a3cc32005-12-18 01:13:11 +01002293Dans la version 1.1.22 est apparue la notion de valeurs par défaut, ce qui
2294évite de répéter des paramètres communs à toutes les instances, tels que les
2295timeouts, adresses de log, modes de fonctionnement, etc.
willy tarreaua41a8b42005-12-17 14:02:24 +01002296
2297Les valeurs par défaut sont positionnées dans la dernière section 'defaults'
2298précédent l'instance qui les utilisera. On peut donc mettre autant de sections
2299'defaults' que l'on veut. Il faut juste se rappeler que la présence d'une telle
2300section implique une annulation de tous les paramètres par défaut positionnés
2301précédemment, dans le but de les remplacer.
2302
2303La section 'defaults' utilise la même syntaxe que la section 'listen', aux
2304paramètres près qui ne sont pas supportés. Le mot clé 'defaults' peut accepter
2305un commentaire en guise paramètre.
2306
willy tarreau982249e2005-12-18 00:57:06 +01002307Dans la version 1.1.28/1.2.1, seuls les paramètres suivants peuvent être
2308positionnés dans une section 'defaults' :
willy tarreaua41a8b42005-12-17 14:02:24 +01002309 - log (le premier et le second)
2310 - mode { tcp, http, health }
2311 - balance { roundrobin }
2312 - disabled (pour désactiver toutes les instances qui suivent)
2313 - enabled (pour faire l'opération inverse, mais c'est le cas par défaut)
2314 - contimeout, clitimeout, srvtimeout, grace, retries, maxconn
willy tarreau982249e2005-12-18 00:57:06 +01002315 - option { redispatch, transparent, keepalive, forwardfor, logasap, httpclose,
2316 checkcache, httplog, tcplog, dontlognull, persist, httpchk }
willy tarreaua41a8b42005-12-17 14:02:24 +01002317 - redispatch, redisp, transparent, source { addr:port }
willy tarreaua41a8b42005-12-17 14:02:24 +01002318 - cookie, capture
2319 - errorloc
willy tarreaueedaa9f2005-12-17 14:08:03 +01002320
2321Ne sont pas supportés dans cette version, les adresses de dispatch et les
2322configurations de serveurs, ainsi que tous les filtres basés sur les
2323expressions régulières :
2324 - dispatch, server,
willy tarreau197e8ec2005-12-17 14:10:59 +01002325 - req*, rsp*
willy tarreaua41a8b42005-12-17 14:02:24 +01002326
2327Enfin, il n'y a pas le moyen, pour le moment, d'invalider un paramètre booléen
2328positionné par défaut. Donc si une option est spécifiée dans les paramètres par
2329défaut, le seul moyen de la désactiver pour une instance, c'est de changer les
2330paramètres par défaut avant la déclaration de l'instance.
2331
2332Exemples :
2333----------
2334 defaults applications TCP
willy tarreauc5f73ed2005-12-18 01:26:38 +01002335 log global
2336 mode tcp
2337 balance roundrobin
2338 clitimeout 180000
2339 srvtimeout 180000
2340 contimeout 4000
2341 retries 3
2342 redispatch
willy tarreaua41a8b42005-12-17 14:02:24 +01002343
2344 listen app_tcp1 10.0.0.1:6000-6063
willy tarreauc5f73ed2005-12-18 01:26:38 +01002345 server srv1 192.168.1.1 check port 6000 inter 10000
2346 server srv2 192.168.1.2 backup
willy tarreaua41a8b42005-12-17 14:02:24 +01002347
2348 listen app_tcp2 10.0.0.2:6000-6063
willy tarreauc5f73ed2005-12-18 01:26:38 +01002349 server srv1 192.168.2.1 check port 6000 inter 10000
2350 server srv2 192.168.2.2 backup
willy tarreaua41a8b42005-12-17 14:02:24 +01002351
2352 defaults applications HTTP
willy tarreauc5f73ed2005-12-18 01:26:38 +01002353 log global
2354 mode http
2355 option httplog
2356 option forwardfor
2357 option dontlognull
2358 balance roundrobin
2359 clitimeout 20000
2360 srvtimeout 20000
2361 contimeout 4000
2362 retries 3
willy tarreaua41a8b42005-12-17 14:02:24 +01002363
2364 listen app_http1 10.0.0.1:80-81
willy tarreauc5f73ed2005-12-18 01:26:38 +01002365 cookie SERVERID postonly insert indirect
2366 capture cookie userid= len 10
2367 server srv1 192.168.1.1:+8000 cookie srv1 check port 8080 inter 1000
2368 server srv1 192.168.1.2:+8000 cookie srv2 check port 8080 inter 1000
willy tarreaua41a8b42005-12-17 14:02:24 +01002369
2370 defaults
willy tarreauc5f73ed2005-12-18 01:26:38 +01002371 # section vide qui annule tous les paramètes par défaut.
willy tarreau8337c6b2005-12-17 13:41:01 +01002372
willy tarreau8f635a42006-05-21 23:05:54 +02002373
23744.8) Rapport d'état sous forme de page HTML
2375-------------------------------------------
2376Avec la version 1.2.14, il devient possible pour haproxy d'interceptre des
2377requêtes pour une URI particulière et de retourner un rapport complet d'état de
2378l'activité du proxy, et des statistiques sur les serveurs. Ceci est disponible
2379via le mot clé "stats" associé à n'importe laquelle de ces options :
2380
2381 - stats enable
2382 - stats uri <uri prefix>
2383 - stats realm <authentication realm>
2384 - stats auth <user:password>
2385 - stats scope <proxy_id> | '.'
2386
2387
2388Par défaut, le rapport est désactivé. Le fait de spécifier une des combinaision
2389ci-dessus active le rapport pour l'instance de proxy qui le référence. La
2390solution la plus simple est d'utiliser "stats enable" qui activera le rapport
2391avec les paramètres par défaut suivant :
2392
2393 - default URI : "/haproxy?stats" (CONFIG_STATS_DEFAULT_URI)
2394 - default auth : non spécifié (pas d'authentication)
2395 - default realm : "HAProxy Statistics" (CONFIG_STATS_DEFAULT_REALM)
2396 - default scope : non specifié (accès à toutes les instances)
2397
2398L'option "stats uri <uri_prefix>" permet d'intercepter un autre préfixe d'URI
2399que celui par défaut. Noter que n'importe quelle URI qui COMMENCE avec cette
2400chaîne sera validée. Par exemple, une instance pourrait être dédiée à la page
2401d'état seulement et répondre à toute URI.
2402
2403Example :
2404---------
2405 # intercepte n'importe quelle URI et retourne la page d'état.
2406 listen stats :8080
2407 mode http
2408 stats uri /
2409
2410
2411L'option "stats auth <user:password>" active l'authentification "Basic" et
2412ajoute un couple "user:password" valide à la liste des comptes autorisés.
2413L'utilisateur <user> et le mot de passe <password> doivent être précisés
2414en clair dans le fichier de configuration, et comme ceci est de
2415l'authentification HTTP "Basic", il faut être conscient qu'ils transitent en
2416clair sur le réseau, donc il ne faut pas utiliser de compte sensible. La liste
2417est illimitée dans le but de pouvoir fournir des accès facilement à des
2418développeurs ou à des clients.
2419
2420L'option "stats realm <realm>" définit le "domaine" ("realm") de validité du
2421mot de passe qui sera présenté dans la boîte de dialogue du navigateur
2422lorsqu'il demandera un compte utilisateur et un mot de passe. Il est important
2423de s'assurer que celui-ci soit différent de ceux utilisés par l'application,
2424autrement le navigateur tentera d'en utiliser un caché depuis l'application.
2425Noter que les espaces dans le nom de "realm" doivent être protégés par un
2426backslash ('\').
2427
2428L'option "stats scope <proxy_id>" limite la portée du rapport d'état. Par
2429défaut, toutes les instances proxy sont listées. Mais dans certaines
2430circonstances, il serait préférable de ne lister que certains proxies ou
2431simplement le proxy courant. C'est ce que fait cette option. Le nom spécial "."
2432(un simple point) référence le proxy courant. Cette option peut être répétée
2433autant de fois que nécessaire pour autoriser d'autres proxies, même pour des
2434noms référencés plus loin dans la configuration ou bien des noms qui n'existent
2435pas encore. Le nom précisé est celui qui apparait après le mot clé "listen".
2436
2437Exemple :
2438---------
2439 # simple application embarquant la page d'état authentifiée
2440 listen app1 192.168.1.100:80
2441 mode http
2442 option httpclose
2443 balance roundrobin
2444 cookie SERVERID postonly insert indirect
2445 server srv1 192.168.1.1:8080 cookie srv1 check inter 1000
2446 server srv1 192.168.1.2:8080 cookie srv2 check inter 1000
2447 stats uri /my_stats
2448 stats realm Statistics\ for\ MyApp1-2
2449 stats auth guest:guest
2450 stats auth admin:AdMiN123
2451 stats scope .
2452 stats scope app2
2453
2454 # simple application embarquant la page d'état sans authentification
2455 listen app2 192.168.2.100:80
2456 mode http
2457 option httpclose
2458 balance roundrobin
2459 cookie SERVERID postonly insert indirect
2460 server srv1 192.168.2.1:8080 cookie srv1 check inter 1000
2461 server srv1 192.168.2.2:8080 cookie srv2 check inter 1000
2462 stats uri /my_stats
2463 stats realm Statistics\ for\ MyApp2
2464 stats scope .
2465
2466 listen admin_page :8080
2467 mode http
2468 stats uri /my_stats
2469 stats realm Global\ statistics
2470 stats auth admin:AdMiN123
2471
2472Notes :
2473-------
2474 - les options "stats" peuvent aussi être spécifiées dans une section
2475 "defaults", auquel cas la même configuration exactement sera fournie à
2476 toutes les instances suivantes, d'où l'utilité du scope ".". Toutefois, si
2477 une instance redéfinit n'importe quel paramètre "stats", alors les défauts
2478 ne lui seront pas appliqués.
2479
2480 - l'authentification "Basic" est très simpliste et non sécurisée contre la
2481 capture réseau. Aucun mot de passe sensible ne doit être utilisé, et il
2482 est bon de savoir qu'il n'existe pas de moyen de le supprimer du navigateur
2483 après usage, donc il sera envoyé tel quel à l'application au cours des
2484 accès successifs.
2485
2486 - Il est très important de préciser l'option "httpclose", sinon le proxy ne
2487 sera pas en mesure de détecter les URI dans les sessions keep-alive
2488 maintenues entre le navigateur et les serveurs, donc les URI de stats
2489 seront transmises telles quelles aux serveurs comme si l'option n'était
2490 pas précisée.
2491
2492
willy tarreaub719f002005-12-17 12:55:07 +01002493=======================
2494| Paramétrage système |
2495=======================
willy tarreau0f7af912005-12-17 12:21:26 +01002496
2497Sous Linux 2.4
2498==============
2499
willy tarreaub719f002005-12-17 12:55:07 +01002500-- cut here --
2501#!/bin/sh
2502# set this to about 256/4M (16384 for 256M machine)
2503MAXFILES=16384
2504echo $MAXFILES > /proc/sys/fs/file-max
2505ulimit -n $MAXFILES
2506
2507if [ -e /proc/sys/net/ipv4/ip_conntrack_max ]; then
willy tarreauc5f73ed2005-12-18 01:26:38 +01002508 echo 65536 > /proc/sys/net/ipv4/ip_conntrack_max
willy tarreaub719f002005-12-17 12:55:07 +01002509fi
2510
2511if [ -e /proc/sys/net/ipv4/netfilter/ip_ct_tcp_timeout_fin_wait ]; then
willy tarreauc5f73ed2005-12-18 01:26:38 +01002512 # 30 seconds for fin, 15 for time wait
2513 echo 3000 > /proc/sys/net/ipv4/netfilter/ip_ct_tcp_timeout_fin_wait
2514 echo 1500 > /proc/sys/net/ipv4/netfilter/ip_ct_tcp_timeout_time_wait
2515 echo 0 > /proc/sys/net/ipv4/netfilter/ip_ct_tcp_log_invalid_scale
2516 echo 0 > /proc/sys/net/ipv4/netfilter/ip_ct_tcp_log_out_of_window
willy tarreaub719f002005-12-17 12:55:07 +01002517fi
2518
willy tarreau0f7af912005-12-17 12:21:26 +01002519echo 1024 60999 > /proc/sys/net/ipv4/ip_local_port_range
willy tarreaub719f002005-12-17 12:55:07 +01002520echo 30 > /proc/sys/net/ipv4/tcp_fin_timeout
2521echo 4096 > /proc/sys/net/ipv4/tcp_max_syn_backlog
willy tarreau0f7af912005-12-17 12:21:26 +01002522echo 262144 > /proc/sys/net/ipv4/tcp_max_tw_buckets
willy tarreaub719f002005-12-17 12:55:07 +01002523echo 262144 > /proc/sys/net/ipv4/tcp_max_orphans
2524echo 300 > /proc/sys/net/ipv4/tcp_keepalive_time
willy tarreau0f7af912005-12-17 12:21:26 +01002525echo 1 > /proc/sys/net/ipv4/tcp_tw_recycle
2526echo 0 > /proc/sys/net/ipv4/tcp_timestamps
willy tarreau5cbea6f2005-12-17 12:48:26 +01002527echo 0 > /proc/sys/net/ipv4/tcp_ecn
willy tarreauc5f73ed2005-12-18 01:26:38 +01002528echo 1 > /proc/sys/net/ipv4/tcp_sack
willy tarreaub719f002005-12-17 12:55:07 +01002529echo 0 > /proc/sys/net/ipv4/tcp_dsack
2530
2531# auto-tuned on 2.4
2532#echo 262143 > /proc/sys/net/core/rmem_max
2533#echo 262143 > /proc/sys/net/core/rmem_default
2534
2535echo 16384 65536 524288 > /proc/sys/net/ipv4/tcp_rmem
2536echo 16384 349520 699040 > /proc/sys/net/ipv4/tcp_wmem
2537
2538-- cut here --
willy tarreau0f7af912005-12-17 12:21:26 +01002539
willy tarreau197e8ec2005-12-17 14:10:59 +01002540Sous FreeBSD
2541============
2542
2543Un port de HA-Proxy sous FreeBSD est désormais disponible, grâce à
2544Clement Laforet <sheepkiller@cultdeadsheep.org>.
2545
2546Pour plus d'informations :
2547http://www.freebsd.org/cgi/url.cgi?ports/net/haproxy/pkg-descr
2548http://www.freebsd.org/cgi/cvsweb.cgi/ports/net/haproxy/
2549http://www.freshports.org/net/haproxy
2550
2551
willy tarreau0f7af912005-12-17 12:21:26 +01002552-- fin --