├── .travis.yml ├── COPYING ├── README.md ├── SplClassLoader.php ├── autoload.php ├── composer.json ├── phpci.yml ├── phpunit.xml.dist ├── src └── HAProxy │ ├── Command │ ├── Base.php │ ├── ClearCounters.php │ ├── DisableServer.php │ ├── EnableServer.php │ ├── HttpModel.php │ ├── NotImplementedException.php │ ├── SendCommand.php │ ├── SetWeight.php │ └── Stats.php │ ├── Exception.php │ ├── Executor.php │ ├── Stats.php │ └── Stats │ ├── Abort.php │ ├── Base.php │ ├── Bytes.php │ ├── Denied.php │ ├── Error.php │ ├── Health.php │ ├── HttpResponseCode.php │ ├── Info.php │ ├── Line.php │ ├── LineCollection.php │ ├── Queue.php │ ├── Rate.php │ ├── Service.php │ ├── Session.php │ └── Warning.php └── tests ├── HAProxy ├── MockExecutor.php ├── StatsFunctionalHttpTest.php ├── StatsFunctionalSocketTest.php └── StatsTest.php ├── bootstrap.php └── resources ├── haproxy-1.4.cfg ├── haproxy-1.5.cfg ├── haproxy-1.6.cfg ├── haproxy-1.7.cfg └── run_functional_tests.sh /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: required 2 | language: php 3 | 4 | services: 5 | - docker 6 | 7 | php: 8 | - 5.6 9 | 10 | install: 11 | - composer install 12 | 13 | script: 14 | - php vendor/bin/phpunit -v 15 | - tests/resources/run_functional_tests.sh 16 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # HAProxyAPI # 2 | ## PHP API for HAProxy administration ## 3 | [![Build Status](https://travis-ci.org/kamermans/HAProxyAPI.png)](https://travis-ci.org/kamermans/HAProxyAPI) 4 | 5 | 6 | This PHP API lets you programatically access HAProxy for both admin and read-only commands like enabling/disabling servers, and checking the status of servers. I can communicate via HAProxy over the builtin HTTP **stats web page**, using the built-in **UNIX domain socket**, or over **TCP** if, for example, you are proxying your domain socket to a TCP socket so you can access it remotely. 7 | 8 | The HAProxy HTTP interface only supports `Stats`, `EnableServer` and `DisableServer`, so use of the domain or TCP socket is required for all other commands. 9 | 10 | HAProxyAPI was written by Steve Kamerman and is distributed under the GNU GPLv3 license. 11 | 12 | ---------- 13 | 14 | # Getting Started # 15 | Before you can use HAProxyAPI, you'll need to include the class loader. The API is PSR-0 compliant and has builtin Composer support. If you don't know what that means, you probably just want to use the included class loader, `autoload.php`: 16 | 17 | ```php 18 | setCredentials('username', 'password'); 33 | ``` 34 | 35 | ## Connecting to HAProxy via Socket ## 36 | Socket communications requires the `stats` configuration option to be enabled, as well as the appropriate permission level to run the commands. Here's and example config for enabling the stats socket: 37 | 38 | ``` 39 | global 40 | stats socket /tmp/haproxy-stats user haproxy group haproxy mode 700 level admin 41 | ``` 42 | 43 | To use the UNIX domain socket interface for HAProxy, you pass its full filename to the constructor: 44 | 45 | ```php 46 | dumpServiceTree(); 79 | ``` 80 | 81 | That will output something like this: 82 | 83 | ``` 84 | +- foo-service 85 | | +- FRONTEND (OPEN) 86 | | 87 | +- foo-nodes 88 | | +- node01.foobar.com (UP) 89 | | +- node02.foobar.com (MAINT) 90 | | +- node03.foobar.com (UP) 91 | | +- node04.foobar.com (UP) 92 | | +- BACKEND (UP) 93 | | 94 | +- stats 95 | | +- FRONTEND (OPEN) 96 | | +- BACKEND (UP) 97 | ``` 98 | 99 | Using this information, you can get statistics about individual servers: 100 | 101 | ```php 102 | getServiceStats('foo-nodes','node01.foobar.com'); 104 | echo "-------------------------------------\n"; 105 | echo "{$server->info->service_name}: {$server->health->status} ({$server->health->check_status} - {$server->health->check_duration}ms )\n"; 106 | echo "-------------------------------------\n"; 107 | echo $server->dump(); 108 | echo "-------------------------------------\n"; 109 | ``` 110 | 111 | Output: 112 | 113 | ``` 114 | ------------------------------------- 115 | node01.foobar.com: UP (L7OK - 4ms ) 116 | ------------------------------------- 117 | Info Stats: 118 | proxy_name: foo-nodes 119 | service_name: node01.foobar.com 120 | weight: 1 121 | process_id: 1 122 | proxy_id: 2 123 | service_id: 1 124 | tracked: 125 | type: 2 126 | Health Stats: 127 | status: UP 128 | active: 1 129 | backup: 0 130 | check_failed: 414 131 | up_down_transitions: 11 132 | status_change: 22700 133 | downtime: 7875 134 | throttle: 135 | selected_total: 1309606 136 | check_status: L7OK 137 | check_code: 200 138 | check_duration: 4 139 | check_fail_details: 0 140 | Queue Stats: 141 | current: 0 142 | max: 0 143 | limit: 144 | Session Stats: 145 | current: 0 146 | max: 26 147 | limit: 148 | Bytes Stats: 149 | in: 697255098 150 | out: 598278314 151 | Rate Stats: 152 | current: 0 153 | max: 49 154 | limit: 155 | Denied Stats: 156 | requests: 157 | responses: 0 158 | Error Stats: 159 | requests: 160 | responses: 0 161 | connections: 2 162 | Warning Stats: 163 | retries: 151 164 | redispatches: 23 165 | HttpResponseCode Stats: 166 | http_1xx: 0 167 | http_2xx: 1308874 168 | http_3xx: 0 169 | http_4xx: 537 170 | http_5xx: 0 171 | ------------------------------------- 172 | ``` 173 | 174 | ## Enabling/Disabling Servers ## 175 | You can put servers into maintanence mode (aka disabled mode) and bring them back up using the `HAProxy\Command\DisableServer` and `HAProxy\Command\EnableServer` HAProxyAPI commands. 176 | 177 | Both commands take a **backend service name** (ex: `foo-nodes`) and a **server name** (ex: `node01.foobar.com`). 178 | 179 | To execute commands, you pass them to the `HAProxy\Executor::execute($command)` method: 180 | 181 | ```php 182 | setCredentials('username', 'password'); 187 | 188 | // Disable foo-nodes/node01.foobar.com in the load balancer 189 | $exec->execute(new HAProxy\Command\DisableServer('foo-nodes', 'node01.foobar.com')); 190 | 191 | // Show stats - you can see node01 is down 192 | echo HAProxy\Stats::get($exec)->dumpServiceTree(); 193 | /* 194 | +- foo-service 195 | | +- FRONTEND (OPEN) 196 | | 197 | +- foo-nodes 198 | | +- node01.foobar.com (MAINT) 199 | | +- node02.foobar.com (UP) 200 | | +- node03.foobar.com (UP) 201 | | +- node04.foobar.com (UP) 202 | | +- BACKEND (UP) 203 | | 204 | +- stats 205 | | +- FRONTEND (OPEN) 206 | | +- BACKEND (UP) 207 | */ 208 | 209 | // Enable foo-nodes/node01.foobar.com 210 | $exec->execute(new HAProxy\Command\EnableServer('foo-nodes', 'node01.foobar.com')); 211 | 212 | // Show stats - you can see node01 is coming up 213 | echo HAProxy\Stats::get($exec)->dumpServiceTree(); 214 | /* 215 | +- foo-service 216 | | +- FRONTEND (OPEN) 217 | | 218 | +- foo-nodes 219 | | +- node01.foobar.com (UP 1/3) 220 | | +- node02.foobar.com (UP) 221 | | +- node03.foobar.com (UP) 222 | | +- node04.foobar.com (UP) 223 | | +- BACKEND (UP) 224 | | 225 | +- stats 226 | | +- FRONTEND (OPEN) 227 | | +- BACKEND (UP) 228 | */ 229 | ``` -------------------------------------------------------------------------------- /SplClassLoader.php: -------------------------------------------------------------------------------- 1 | register(); 13 | * 14 | * @author Jonathan H. Wage 15 | * @author Roman S. Borschel 16 | * @author Matthew Weier O'Phinney 17 | * @author Kris Wallsmith 18 | * @author Fabien Potencier 19 | */ 20 | class SplClassLoader 21 | { 22 | private $_fileExtension = '.php'; 23 | private $_namespace; 24 | private $_includePath; 25 | private $_namespaceSeparator = '\\'; 26 | 27 | /** 28 | * Creates a new SplClassLoader that loads classes of the 29 | * specified namespace. 30 | * 31 | * @param string $ns The namespace to use. 32 | */ 33 | public function __construct($ns = null, $includePath = null) 34 | { 35 | $this->_namespace = $ns; 36 | $this->_includePath = $includePath; 37 | } 38 | 39 | /** 40 | * Sets the namespace separator used by classes in the namespace of this class loader. 41 | * 42 | * @param string $sep The separator to use. 43 | */ 44 | public function setNamespaceSeparator($sep) 45 | { 46 | $this->_namespaceSeparator = $sep; 47 | } 48 | 49 | /** 50 | * Gets the namespace seperator used by classes in the namespace of this class loader. 51 | * 52 | * @return void 53 | */ 54 | public function getNamespaceSeparator() 55 | { 56 | return $this->_namespaceSeparator; 57 | } 58 | 59 | /** 60 | * Sets the base include path for all class files in the namespace of this class loader. 61 | * 62 | * @param string $includePath 63 | */ 64 | public function setIncludePath($includePath) 65 | { 66 | $this->_includePath = $includePath; 67 | } 68 | 69 | /** 70 | * Gets the base include path for all class files in the namespace of this class loader. 71 | * 72 | * @return string $includePath 73 | */ 74 | public function getIncludePath() 75 | { 76 | return $this->_includePath; 77 | } 78 | 79 | /** 80 | * Sets the file extension of class files in the namespace of this class loader. 81 | * 82 | * @param string $fileExtension 83 | */ 84 | public function setFileExtension($fileExtension) 85 | { 86 | $this->_fileExtension = $fileExtension; 87 | } 88 | 89 | /** 90 | * Gets the file extension of class files in the namespace of this class loader. 91 | * 92 | * @return string $fileExtension 93 | */ 94 | public function getFileExtension() 95 | { 96 | return $this->_fileExtension; 97 | } 98 | 99 | /** 100 | * Installs this class loader on the SPL autoload stack. 101 | */ 102 | public function register() 103 | { 104 | spl_autoload_register(array($this, 'loadClass')); 105 | } 106 | 107 | /** 108 | * Uninstalls this class loader from the SPL autoloader stack. 109 | */ 110 | public function unregister() 111 | { 112 | spl_autoload_unregister(array($this, 'loadClass')); 113 | } 114 | 115 | /** 116 | * Loads the given class or interface. 117 | * 118 | * @param string $className The name of the class to load. 119 | * @return void 120 | */ 121 | public function loadClass($className) 122 | { 123 | if (null === $this->_namespace || $this->_namespace.$this->_namespaceSeparator === substr($className, 0, strlen($this->_namespace.$this->_namespaceSeparator))) { 124 | $fileName = ''; 125 | $namespace = ''; 126 | if (false !== ($lastNsPos = strripos($className, $this->_namespaceSeparator))) { 127 | $namespace = substr($className, 0, $lastNsPos); 128 | $className = substr($className, $lastNsPos + 1); 129 | $fileName = str_replace($this->_namespaceSeparator, DIRECTORY_SEPARATOR, $namespace) . DIRECTORY_SEPARATOR; 130 | } 131 | $fileName .= str_replace('_', DIRECTORY_SEPARATOR, $className) . $this->_fileExtension; 132 | $filePath = ($this->_includePath !== null ? $this->_includePath . DIRECTORY_SEPARATOR : '') . $fileName; 133 | require $filePath; 134 | } 135 | } 136 | } -------------------------------------------------------------------------------- /autoload.php: -------------------------------------------------------------------------------- 1 | register(); 10 | }); -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "kamermans/haproxy-api", 3 | "description": "PHP API for HAProxy administration", 4 | "type": "library", 5 | "license": "GPLv3", 6 | "keywords": [ 7 | "haproxy" 8 | ], 9 | "homepage": "https://github.com/kamermans/HAProxyAPI", 10 | "authors": [ 11 | { 12 | "name": "Steve Kamerman", 13 | "email": "stevekamerman@gmail.com", 14 | "homepage": "http://www.stevekamerman.com" 15 | } 16 | ], 17 | "require": { 18 | "php": ">=5.3.0" 19 | }, 20 | "require-dev": { 21 | "phpunit/phpunit": "~5" 22 | }, 23 | "autoload": { 24 | "psr-4": { 25 | "HAProxy\\": ["src/HAProxy/", "tests/HAProxy/"] 26 | } 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /phpci.yml: -------------------------------------------------------------------------------- 1 | setup: 2 | composer: 3 | action: "install" 4 | 5 | test: 6 | php_unit: 7 | config: 8 | - "phpunit.xml.dist" 9 | 10 | php_cpd: 11 | allow_failures: true 12 | 13 | -------------------------------------------------------------------------------- /phpunit.xml.dist: -------------------------------------------------------------------------------- 1 | 2 | 3 | 14 | 15 | 16 | ./tests/HAProxy 17 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /src/HAProxy/Command/Base.php: -------------------------------------------------------------------------------- 1 | . 27 | */ 28 | 29 | namespace HAProxy\Command; 30 | 31 | class Base { 32 | 33 | protected $response_map = array( 34 | 'DONE' => 'Action processed successfully.', 35 | 'NONE' => 'Nothing has changed.', 36 | 'EXCD' => 'Action not processed: the buffer couldn\'t store all the data. You should retry with less servers at a time.', 37 | 'DENY' => 'Action denied.', 38 | 'ERRP' => 'Invalid parameters.', 39 | 'PART' => 'Action was only partially successful.', 40 | 'UNKN' => 'Unexpected error.' 41 | ); 42 | 43 | public function getSocketCommand() { 44 | throw new NotImplementedException(); 45 | } 46 | /** 47 | * Represents an HTTP command 48 | * @return HttpModel 49 | * @throws NotImplementedException 50 | */ 51 | public function getHttpCommand() { 52 | throw new NotImplementedException(); 53 | } 54 | 55 | public function processHttpResponse($response) { 56 | $response_lines = preg_split('/[\n\r]+/', $response); 57 | $http_code = $this->getHttpCode($response_lines); 58 | if ($http_code >= 400) { 59 | throw new \HAProxy\Exception("Server responded with HTTP $http_code"); 60 | } 61 | return $this->getResponseMessage($response_lines); 62 | } 63 | 64 | public function processSocketResponse($response) { 65 | return $response; 66 | } 67 | 68 | protected function getHttpCode($response_lines) { 69 | if (preg_match('#HTTP/\d\.\d (\d\d\d) #', $response_lines[0], $matches)) { 70 | return (int)$matches[0]; 71 | } 72 | } 73 | 74 | protected function getResponseMessage($response_lines) { 75 | //var_export($response_lines); 76 | foreach ($response_lines as $line) { 77 | if (preg_match('/^[Ll]ocation.+;st=(DONE|NONE|EXCD|DENY|UNKN|PART|ERRP)/', $line, $matches)) { 78 | return $this->response_map[$matches[1]]; 79 | } 80 | } 81 | return 'Unable to parse server response'; 82 | } 83 | } 84 | -------------------------------------------------------------------------------- /src/HAProxy/Command/ClearCounters.php: -------------------------------------------------------------------------------- 1 | . 27 | */ 28 | 29 | namespace HAProxy\Command; 30 | 31 | class ClearCounters extends Base { 32 | 33 | protected $all = false; 34 | 35 | public function __construct($all=false) { 36 | $this->all = $all; 37 | } 38 | 39 | public function getSocketCommand() { 40 | return 'clear counters'.($this->all? ' all': ''); 41 | } 42 | } -------------------------------------------------------------------------------- /src/HAProxy/Command/DisableServer.php: -------------------------------------------------------------------------------- 1 | . 27 | */ 28 | 29 | namespace HAProxy\Command; 30 | 31 | class DisableServer extends EnableServer { 32 | protected $action = 'disable'; 33 | } -------------------------------------------------------------------------------- /src/HAProxy/Command/EnableServer.php: -------------------------------------------------------------------------------- 1 | . 27 | */ 28 | 29 | namespace HAProxy\Command; 30 | 31 | class EnableServer extends Base { 32 | 33 | protected $backend; 34 | protected $server; 35 | protected $action = 'enable'; 36 | 37 | public function __construct($backend, $server) { 38 | $this->backend = $backend; 39 | $this->server = $server; 40 | } 41 | 42 | public function getSocketCommand() { 43 | return "$this->action server $this->backend/$this->server"; 44 | } 45 | 46 | public function getHttpCommand() { 47 | return new HttpModel(array( 48 | 's' => $this->server, 49 | 'action' => $this->action, 50 | 'b' => $this->backend, 51 | ), 'post'); 52 | } 53 | } -------------------------------------------------------------------------------- /src/HAProxy/Command/HttpModel.php: -------------------------------------------------------------------------------- 1 | . 27 | */ 28 | 29 | namespace HAProxy\Command; 30 | 31 | class HttpModel { 32 | public $method; 33 | public $data; 34 | public function __construct($data, $method='get') { 35 | $this->data = $data; 36 | $this->method = strtolower($method); 37 | } 38 | } -------------------------------------------------------------------------------- /src/HAProxy/Command/NotImplementedException.php: -------------------------------------------------------------------------------- 1 | . 27 | */ 28 | 29 | namespace HAProxy\Command; 30 | 31 | class NotImplementedException extends \HAProxy\Exception { 32 | public function __construct() { 33 | parent::__construct(); 34 | } 35 | } -------------------------------------------------------------------------------- /src/HAProxy/Command/SendCommand.php: -------------------------------------------------------------------------------- 1 | . 27 | */ 28 | 29 | namespace HAProxy\Command; 30 | 31 | class SendCommand extends EnableServer { 32 | public function __construct($backend, $server, $action) { 33 | $this->backend = $backend; 34 | $this->server = $server; 35 | $this->action = $action; 36 | } 37 | } 38 | -------------------------------------------------------------------------------- /src/HAProxy/Command/SetWeight.php: -------------------------------------------------------------------------------- 1 | . 27 | */ 28 | 29 | namespace HAProxy\Command; 30 | 31 | class SetWeight extends Base { 32 | 33 | protected $backend; 34 | protected $server; 35 | protected $weight; 36 | 37 | public function __construct($backend, $server, $weight) { 38 | $this->backend = $backend; 39 | $this->server = $server; 40 | } 41 | 42 | public function getSocketCommand() { 43 | return "set weight $this->backend/$this->server"; 44 | } 45 | } -------------------------------------------------------------------------------- /src/HAProxy/Command/Stats.php: -------------------------------------------------------------------------------- 1 | . 27 | */ 28 | 29 | namespace HAProxy\Command; 30 | 31 | class Stats extends Base { 32 | 33 | public function getSocketCommand() { 34 | return 'show stat'; 35 | } 36 | /** 37 | * Represents an HTTP command 38 | * @return HttpModel 39 | * @throws NotImplementedException 40 | */ 41 | public function getHttpCommand() { 42 | return new HttpModel(array('csv' => null), 'get'); 43 | } 44 | 45 | public function processHttpResponse($response) { 46 | list($headers, $body) = preg_split('/\r\n\r\n/', $response, 2); 47 | return $body; 48 | } 49 | } -------------------------------------------------------------------------------- /src/HAProxy/Exception.php: -------------------------------------------------------------------------------- 1 | . 27 | */ 28 | 29 | namespace HAProxy; 30 | 31 | class Exception extends \Exception {} -------------------------------------------------------------------------------- /src/HAProxy/Executor.php: -------------------------------------------------------------------------------- 1 | . 27 | */ 28 | 29 | namespace HAProxy; 30 | 31 | use HAProxy\Command\Base; 32 | 33 | class Executor { 34 | 35 | const SOCKET = 'socket'; 36 | const HTTP = 'http'; 37 | 38 | protected $connection_string; 39 | protected $method; 40 | protected $http_auth; 41 | protected $socket; 42 | 43 | public function __construct($connection_string, $method) { 44 | $this->connection_string = $connection_string; 45 | $this->method = $method; 46 | } 47 | 48 | public function setCredentials($username, $password) { 49 | $this->http_auth = $username.':'.$password; 50 | } 51 | 52 | public function execute(Base $command) { 53 | switch ($this->method) { 54 | case self::SOCKET: 55 | return $command->processSocketResponse($this->executeSocket($command)); 56 | break; 57 | default: 58 | case self::HTTP: 59 | return $command->processHttpResponse($this->executeHttp($command)); 60 | break; 61 | } 62 | } 63 | 64 | protected function executeSocket(Base $command) { 65 | $this->openSocket(); 66 | fwrite($this->socket, $command->getSocketCommand()."\n"); 67 | $response = ''; 68 | while (!feof($this->socket)) { 69 | $response .= fgets($this->socket, 1024); 70 | } 71 | $this->closeSocket(); 72 | return $response; 73 | } 74 | 75 | protected function executeHttp(Base $command) { 76 | $data_model = $command->getHttpCommand(); 77 | $ch = curl_init(); 78 | $url = $this->connection_string; 79 | if ($data_model->method == 'get') { 80 | foreach ($data_model->data as $key => $value) { 81 | if ($value === null) { 82 | $url .= ";$key"; 83 | } else { 84 | $url .= ";$key=$value"; 85 | } 86 | } 87 | } 88 | curl_setopt($ch, CURLOPT_URL, $url); 89 | curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); 90 | curl_setopt($ch, CURLOPT_HEADER, true); 91 | curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC); 92 | curl_setopt($ch, CURLOPT_USERPWD, $this->http_auth); 93 | if ($data_model->method == 'post') { 94 | curl_setopt($ch, CURLOPT_POST, count($data_model->data)); 95 | curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data_model->data)); 96 | } 97 | $response = curl_exec($ch); 98 | //echo "Request: ".var_export(array('url'=>$url,'post'=>http_build_query($data_model->data)), true)."\n"; 99 | $curl_errno = curl_errno($ch); 100 | $curl_error = curl_error($ch); 101 | curl_close($ch); 102 | if ($curl_errno !== 0) { 103 | throw new Exception("Unable to contact server: cURL Error: $curl_error"); 104 | } 105 | return $response; 106 | } 107 | 108 | protected function openSocket() { 109 | if (strpos($this->connection_string, ':')) { 110 | // TCP Socket, @ to hide warnings. 111 | $this->socket = @stream_socket_client('tcp://'.$this->connection_string, $errorno, $errorstr); 112 | } else if (@filetype(realpath($this->connection_string)) == 'socket') { 113 | // UNIX Domain Socket, @ to hide warnings. 114 | $this->socket = @stream_socket_client('unix://'.realpath($this->connection_string), $errorno, $errorstr); 115 | } else { 116 | throw new Exception("Could not open a connection to \"$this->connection_string\": the connection string is invalid"); 117 | } 118 | if (!$this->socket) { 119 | throw new Exception("Could not open a connection to \"$this->connection_string\": $errorstr ($errorno)"); 120 | } 121 | } 122 | 123 | protected function closeSocket() { 124 | if ($this->socket) { 125 | @fwrite($this->socket, "quit\n"); 126 | @fclose($this->socket); 127 | } 128 | } 129 | 130 | public function __destruct() { 131 | $this->closeSocket(); 132 | } 133 | } 134 | -------------------------------------------------------------------------------- /src/HAProxy/Stats.php: -------------------------------------------------------------------------------- 1 | . 27 | */ 28 | 29 | namespace HAProxy; 30 | 31 | use HAProxy\Stats\LineCollection; 32 | use HAProxy\Stats\Service; 33 | 34 | class Stats { 35 | 36 | /** 37 | * Stores the tree 38 | * @var array 39 | */ 40 | protected $proxy_tree = array(); 41 | 42 | /** 43 | * Sets the statistics from the raw CSV stats output from HAProxy 44 | * @param string $raw_stats 45 | * @return Stats $this 46 | */ 47 | public function setFromStatsString($raw_stats) { 48 | $this->setFromStatsCollection(new LineCollection($raw_stats)); 49 | return $this; 50 | } 51 | 52 | /** 53 | * Sets the statistics from a Stats LineCollection 54 | * @param LineCollection $collection 55 | * @return Stats $this 56 | */ 57 | public function setFromStatsCollection(LineCollection $collection) { 58 | $this->proxy_tree = array(); 59 | foreach ($collection as $line) { 60 | /* @var $line Stats\Line */ 61 | $service = Service::createFromLine($line); 62 | if (array_key_exists($service->info->proxy_name, $this->proxy_tree)) { 63 | $this->proxy_tree[$service->info->proxy_name][$service->info->service_name] = $service; 64 | } else { 65 | $this->proxy_tree[$service->info->proxy_name] = array($service->info->service_name => $service); 66 | } 67 | } 68 | return $this; 69 | } 70 | 71 | /** 72 | * Returns true if the given backend exists 73 | * @param string $backend Backend name 74 | * @return boolean 75 | */ 76 | public function backendExists($backend) { 77 | return array_key_exists($backend, $this->proxy_tree); 78 | } 79 | 80 | /** 81 | * Returns true if the given server exists on the given backend 82 | * @param string $backend Backend name 83 | * @param string $server Server name 84 | * @return boolean 85 | */ 86 | public function serverExists($backend, $server) { 87 | return ($this->backendExists($backend) && array_key_exists($server, $this->proxy_tree[$backend])); 88 | } 89 | 90 | /** 91 | * Gets all the services belonging to a given backend 92 | * @param string $backend Backend name 93 | * @return Stats\Service[] 94 | * @throws Exception 95 | */ 96 | public function getBackendServices($backend) { 97 | if (!$this->backendExists($backend)) throw new Exception("Backend does not exist: $backend"); 98 | return $this->proxy_tree[$backend]; 99 | } 100 | 101 | /** 102 | * Gets statistics for an individual service 103 | * @param string $backend Backend name 104 | * @param string $server Server name 105 | * @return Stats\Service 106 | * @throws Exception 107 | * @see getBackendNames() 108 | * @see getServerNames() 109 | */ 110 | public function getServiceStats($backend, $server) { 111 | if (!$this->backendExists($backend)) throw new Exception("Backend does not exist: $backend"); 112 | if (!$this->serverExists($backend, $server)) throw new Exception("Server does not exist: $server"); 113 | return $this->proxy_tree[$backend][$server]; 114 | } 115 | 116 | /** 117 | * Returns an array of all the backend names 118 | * @return array 119 | */ 120 | public function getBackendNames() { 121 | $list = array(); 122 | foreach ($this->proxy_tree as $name => $obj) { 123 | $list[] = $name; 124 | } 125 | return $list; 126 | } 127 | 128 | /** 129 | * Returns an array of all the server names on a given backend 130 | * @param string $backend Backend name 131 | * @return array 132 | * @throws Exception 133 | */ 134 | public function getServerNames($backend) { 135 | if (!$this->backendExists($backend)) throw new Exception("Backend does not exist: $backend"); 136 | $list = array(); 137 | foreach ($this->proxy_tree[$backend] as $name => $obj) { 138 | $list[] = $name; 139 | } 140 | return $list; 141 | } 142 | 143 | /** 144 | * Returns a human-readable ASCII art tree diagram showing the names of all the backends and servers 145 | * @return string 146 | */ 147 | public function dumpServiceTree() { 148 | $out = "\n"; 149 | $i = 0; 150 | foreach ($this->proxy_tree as $name => $services) { 151 | $out .= "+- $name\n"; 152 | foreach ($services as $service_name => $server) { 153 | $out .= "| +- $service_name ({$server->info->status})\n"; 154 | } 155 | if (++$i < count($this->proxy_tree)) $out .= "|\n"; 156 | } 157 | return $out; 158 | } 159 | 160 | public function getTree() { 161 | return $this->proxy_tree; 162 | } 163 | 164 | /** 165 | * Gets statistics using the given executor 166 | * @param Executor $exec 167 | * @return Stats 168 | */ 169 | public static function get(Executor $exec) { 170 | $stats = new Stats(); 171 | $stats->setFromStatsString($exec->execute(new Command\Stats())); 172 | return $stats; 173 | } 174 | } 175 | -------------------------------------------------------------------------------- /src/HAProxy/Stats/Abort.php: -------------------------------------------------------------------------------- 1 | . 27 | */ 28 | 29 | namespace HAProxy\Stats; 30 | 31 | class Abort extends Base { 32 | protected $map = array( 33 | 'cli_abrt' => 'client', 34 | 'srv_abrt' => 'server', 35 | ); 36 | 37 | /** 38 | * number of data transfers aborted by the client 39 | * @var string 40 | */ 41 | public $client; 42 | /** 43 | * number of data transfers aborted by the server (inc. in eresp) 44 | * @var string 45 | */ 46 | public $server; 47 | } -------------------------------------------------------------------------------- /src/HAProxy/Stats/Base.php: -------------------------------------------------------------------------------- 1 | . 27 | */ 28 | 29 | namespace HAProxy\Stats; 30 | 31 | 32 | abstract class Base { 33 | /** 34 | * @var Line 35 | */ 36 | protected $line; 37 | protected $map = array(); 38 | 39 | public function __construct(Line $line) { 40 | $this->line = $line; 41 | $this->assignValues(); 42 | } 43 | 44 | public function __get($name) { 45 | return $this->line->$name; 46 | } 47 | 48 | protected function assignValues() { 49 | foreach ($this->map as $raw_name => $property) { 50 | $this->$property = $this->line->$raw_name; 51 | } 52 | } 53 | 54 | public function dump() { 55 | $out = ''; 56 | if (function_exists('get_called_class')) { 57 | $out .= self::getNiceName()." Stats:\n"; 58 | } 59 | foreach ($this->map as $raw_name => $prop) { 60 | $out .= "\t$prop: {$this->$prop}\n"; 61 | } 62 | return $out; 63 | } 64 | 65 | public static function getNiceName() { 66 | return self::stripNamespaces(self::getClassName()); 67 | } 68 | 69 | protected static function getClassName() { 70 | return get_called_class(); 71 | } 72 | 73 | /** 74 | * Returns the class "\foo\bar\is\cool" without its namespaces, so like "cool" 75 | * @param string|object $class 76 | * @return string 77 | */ 78 | public static function stripNamespaces($class) { 79 | $class_name = is_string($class)? $class: get_class($class); 80 | $parts = explode('\\', $class_name); 81 | return array_pop($parts); 82 | } 83 | 84 | } 85 | -------------------------------------------------------------------------------- /src/HAProxy/Stats/Bytes.php: -------------------------------------------------------------------------------- 1 | . 27 | */ 28 | 29 | namespace HAProxy\Stats; 30 | 31 | class Bytes extends Base { 32 | protected $map = array( 33 | 'bin' => 'in', 34 | 'bout' => 'out', 35 | ); 36 | 37 | /** 38 | * inbound traffic in bytes 39 | * @var string 40 | */ 41 | public $in; 42 | /** 43 | * outbound traffic in bytes 44 | * @var string 45 | */ 46 | public $out; 47 | } -------------------------------------------------------------------------------- /src/HAProxy/Stats/Denied.php: -------------------------------------------------------------------------------- 1 | . 27 | */ 28 | 29 | namespace HAProxy\Stats; 30 | 31 | class Denied extends Base { 32 | protected $map = array( 33 | 'dreq' => 'requests', 34 | 'dresp' => 'responses', 35 | ); 36 | 37 | /** 38 | * denied requests 39 | * @var string 40 | */ 41 | public $requests; 42 | /** 43 | * denied responses 44 | * @var string 45 | */ 46 | public $responses; 47 | } -------------------------------------------------------------------------------- /src/HAProxy/Stats/Error.php: -------------------------------------------------------------------------------- 1 | . 27 | */ 28 | 29 | namespace HAProxy\Stats; 30 | 31 | class Error extends Base { 32 | protected $map = array( 33 | 'ereq' => 'requests', 34 | 'eresp' => 'responses', 35 | 'econ' => 'connections', 36 | ); 37 | 38 | /** 39 | * request errors 40 | * @var string 41 | */ 42 | public $requests; 43 | /** 44 | * response errors (among which srv_abrt) 45 | * @var string 46 | */ 47 | public $responses; 48 | /** 49 | * connection errors 50 | * @var string 51 | */ 52 | public $connections; 53 | } -------------------------------------------------------------------------------- /src/HAProxy/Stats/Health.php: -------------------------------------------------------------------------------- 1 | . 27 | */ 28 | 29 | namespace HAProxy\Stats; 30 | 31 | 32 | class Health extends Base { 33 | 34 | protected $map = array( 35 | 'status' => 'status', 36 | 'act' => 'active', 37 | 'bck' => 'backup', 38 | 'chkfail' => 'check_failed', 39 | 'chkdown' => 'up_down_transitions', 40 | 'lastchg' => 'status_change', 41 | 'downtime' => 'downtime', 42 | 'throttle' => 'throttle', 43 | 'lbtot' => 'selected_total', 44 | 'check_status' => 'check_status', 45 | 'check_code' => 'check_code', 46 | 'check_duration' => 'check_duration', 47 | 'hanafail' => 'check_fail_details', 48 | ); 49 | 50 | /** 51 | * status (UP/DOWN/NOLB/MAINT/MAINT(via)...) 52 | * @var string 53 | */ 54 | public $status; 55 | /** 56 | * server is active (server), number of active servers (backend) 57 | * @var string 58 | */ 59 | public $active; 60 | /** 61 | * server is backup (server), number of backup servers (backend) 62 | * @var string 63 | */ 64 | public $backup; 65 | /** 66 | * number of failed checks 67 | * @var string 68 | */ 69 | public $check_failed; 70 | /** 71 | * number of UP->DOWN transitions 72 | * @var string 73 | */ 74 | public $up_down_transitions; 75 | /** 76 | * last status change (in seconds) 77 | * @var string 78 | */ 79 | public $status_change; 80 | /** 81 | * total downtime (in seconds) 82 | * @var string 83 | */ 84 | public $downtime; 85 | /** 86 | * warm up status 87 | * @var string 88 | */ 89 | public $throttle; 90 | /** 91 | * total number of times a server was selected 92 | * @var string 93 | */ 94 | public $selected_total; 95 | /** 96 | * status of last health check 97 | * @see getCheckStatusDescription() 98 | * @var string 99 | */ 100 | public $check_status; 101 | /** 102 | * layer5-7 code, if available 103 | * @var string 104 | */ 105 | public $check_code; 106 | /** 107 | * time in ms took to finish last health check 108 | * @var string 109 | */ 110 | public $check_duration; 111 | /** 112 | * failed health checks details 113 | * @var string 114 | */ 115 | public $check_fail_details; 116 | 117 | protected $check_status_desc = array( 118 | 'UNK' => 'unknown', 119 | 'INI' => 'initializing', 120 | 'SOCKERR' => 'socket error', 121 | 'L4OK' => 'check passed on layer 4, no upper layers testing enabled', 122 | 'L4TMOUT' => 'layer 1-4 timeout', 123 | 'L4CON' => 'layer 1-4 connection problem, for example "Connection refused" (tcp rst) or "No route to host" (icmp)', 124 | 'L6OK' => 'check passed on layer 6', 125 | 'L6TOUT' => 'layer 6 (SSL) timeout', 126 | 'L6RSP' => 'layer 6 invalid response - protocol error', 127 | 'L7OK' => 'check passed on layer 7', 128 | 'L7OKC' => 'check conditionally passed on layer 7, for example 404 with disable-on-404', 129 | 'L7TOUT' => 'layer 7 (HTTP/SMTP) timeout', 130 | 'L7RSP' => 'layer 7 invalid response - protocol error', 131 | 'L7STS' => 'layer 7 response error, for example HTTP 5xx', 132 | ); 133 | 134 | public function getCheckStatusDescription() { 135 | return $this->check_status_desc[$this->check_status]; 136 | } 137 | } -------------------------------------------------------------------------------- /src/HAProxy/Stats/HttpResponseCode.php: -------------------------------------------------------------------------------- 1 | . 27 | */ 28 | 29 | namespace HAProxy\Stats; 30 | 31 | class HttpResponseCode extends Base { 32 | protected $map = array( 33 | 'hrsp_1xx' => 'http_1xx', 34 | 'hrsp_2xx' => 'http_2xx', 35 | 'hrsp_3xx' => 'http_3xx', 36 | 'hrsp_4xx' => 'http_4xx', 37 | 'hrsp_5xx' => 'http_5xx', 38 | ); 39 | 40 | /** 41 | * number of HTTP 1xx (Informational) responses sent 42 | * @var string 43 | */ 44 | public $http_1xx; 45 | /** 46 | * number of HTTP 2xx (Successful) responses sent 47 | * @var string 48 | */ 49 | public $http_2xx; 50 | /** 51 | * number of HTTP 3xx (Redirection) responses sent 52 | * @var string 53 | */ 54 | public $http_3xx; 55 | /** 56 | * number of HTTP 4xx (Client Error) responses sent 57 | * @var string 58 | */ 59 | public $http_4xx; 60 | /** 61 | * number of HTTP 5xx (Internal Server Error) responses sent 62 | * @var string 63 | */ 64 | public $http_5xx; 65 | 66 | } -------------------------------------------------------------------------------- /src/HAProxy/Stats/Info.php: -------------------------------------------------------------------------------- 1 | . 27 | */ 28 | 29 | namespace HAProxy\Stats; 30 | 31 | class Info extends Base { 32 | 33 | const TYPE_FRONTEND = 0; 34 | const TYPE_BACKEND = 1; 35 | const TYPE_SERVER = 2; 36 | const TYPE_SOCKET = 4; 37 | 38 | protected $map = array( 39 | 'pxname' => 'proxy_name', 40 | 'svname' => 'service_name', 41 | 'weight' => 'weight', 42 | 'pid' => 'process_id', 43 | 'iid' => 'proxy_id', 44 | 'sid' => 'service_id', 45 | 'tracked' => 'tracked', 46 | 'type' => 'type', 47 | ); 48 | 49 | /** 50 | * type of service (0=frontend, 1=backend, 2=server, 3=socket) 51 | * @var string 52 | */ 53 | public $type; 54 | /** 55 | * proxy name 56 | * @var string 57 | */ 58 | public $proxy_name; 59 | /** 60 | * service name (FRONTEND for frontend, BACKEND for backend, any name for server) 61 | * @var string 62 | */ 63 | public $service_name; 64 | /** 65 | * process id (0 for first instance, 1 for second, ...) 66 | * @var string 67 | */ 68 | public $process_id; 69 | /** 70 | * unique proxy id 71 | * @var string 72 | */ 73 | public $proxy_id; 74 | /** 75 | * service id (unique inside a proxy) 76 | * @var string 77 | */ 78 | public $service_id; 79 | /** 80 | * server weight (for servers) or total weight (for backends) 81 | * @var string 82 | */ 83 | public $weight; 84 | /** 85 | * id of proxy/server if tracking is enabled 86 | * @var string 87 | */ 88 | public $tracked; 89 | 90 | /** 91 | * true if this is a frontend proxy service (NOT an individual server) 92 | * @return boolean 93 | */ 94 | public function isFrontend() { 95 | return ($this->type == self::TYPE_FRONTEND); 96 | } 97 | /** 98 | * true if this is a backend proxy service (NOT an individual server) 99 | * @return boolean 100 | */ 101 | public function isBackend() { 102 | return ($this->type == self::TYPE_BACKEND); 103 | } 104 | /** 105 | * true if this is an individual server 106 | * @return boolean 107 | */ 108 | public function isServer() { 109 | // These can never both be true, so they must both be false, therefore this is a server :) 110 | return ($this->type == self::TYPE_SERVER); 111 | } 112 | } -------------------------------------------------------------------------------- /src/HAProxy/Stats/Line.php: -------------------------------------------------------------------------------- 1 | . 27 | */ 28 | 29 | namespace HAProxy\Stats; 30 | 31 | class Line { 32 | 33 | protected $data; 34 | 35 | public function __construct($columns, $line) { 36 | $values = explode(',', $line); 37 | if (count($columns) != count($values)) { 38 | die('Column count mismatch: '.count($columns).' columns; '.count($values).' values'); 39 | } 40 | $this->data = array_combine($columns, $values); 41 | } 42 | 43 | public function __get($name) { 44 | return $this->data[$name]; 45 | } 46 | 47 | public function getAssoc() { 48 | return $this->data; 49 | } 50 | } -------------------------------------------------------------------------------- /src/HAProxy/Stats/LineCollection.php: -------------------------------------------------------------------------------- 1 | . 27 | */ 28 | 29 | namespace HAProxy\Stats; 30 | 31 | use HAProxy\Stats\Line; 32 | 33 | class LineCollection implements \Iterator { 34 | 35 | protected $lines = array(); 36 | protected $columns = array(); 37 | protected $storage = array(); 38 | protected $iter_index = 0; 39 | 40 | public function __construct($stats_string) { 41 | $raw_lines = $this->splitRawStats($stats_string); 42 | $this->columns = $this->getColumnsFromHeader(array_shift($raw_lines)); 43 | $this->lines = $this->createLines($this->columns, $raw_lines); 44 | } 45 | 46 | protected function splitRawStats($stats_string) { 47 | return preg_split('/\r?\n/', $stats_string); 48 | } 49 | 50 | protected function getColumnsFromHeader($line) { 51 | $line = preg_replace('/^[# ]+/', '', $line); 52 | return explode(',', $line); 53 | } 54 | 55 | protected function createLines(array $columns, array $raw_lines) { 56 | $lines = array(); 57 | foreach ($raw_lines as $line) { 58 | if ((substr_count($line, ',') + 1) != count($columns)) continue; 59 | $lines[] = new Line($columns, $line); 60 | } 61 | return $lines; 62 | } 63 | 64 | public function getColumns() { 65 | return $this->columns; 66 | } 67 | 68 | public function count() { 69 | return count($this->lines); 70 | } 71 | 72 | public function getLine($line_num) { 73 | return $this->lines[$line_num]; 74 | } 75 | 76 | public function getValue($line_num, $name) { 77 | return $this->lines[$line_num]->$name; 78 | } 79 | 80 | public function __toString() { 81 | return $this->dump(); 82 | } 83 | 84 | public function dump() { 85 | $out = array(); 86 | foreach ($this->lines as $line_num => $line) { 87 | /* @var $line Line */ 88 | $out[] = $line->getAssoc(); 89 | } 90 | return var_export($out, true); 91 | } 92 | 93 | public function rewind() { 94 | $this->iter_index = 0; 95 | } 96 | 97 | public function valid() { 98 | return isset($this->lines[$this->iter_index]); 99 | } 100 | 101 | public function current() { 102 | return $this->lines[$this->iter_index]; 103 | } 104 | 105 | public function key() { 106 | return $this->iter_index; 107 | } 108 | 109 | public function next() { 110 | $this->iter_index++; 111 | } 112 | } 113 | -------------------------------------------------------------------------------- /src/HAProxy/Stats/Queue.php: -------------------------------------------------------------------------------- 1 | . 27 | */ 28 | 29 | namespace HAProxy\Stats; 30 | 31 | class Queue extends Base { 32 | protected $map = array( 33 | 'qcur' => 'current', 34 | 'qmax' => 'max', 35 | 'qlimit' => 'limit', 36 | ); 37 | 38 | /** 39 | * current queued requests 40 | * @var string 41 | */ 42 | public $current; 43 | /** 44 | * max queued requests 45 | * @var string 46 | */ 47 | public $max; 48 | /** 49 | * queue limit 50 | * @var string 51 | */ 52 | public $limit; 53 | } -------------------------------------------------------------------------------- /src/HAProxy/Stats/Rate.php: -------------------------------------------------------------------------------- 1 | . 27 | */ 28 | 29 | namespace HAProxy\Stats; 30 | 31 | class Rate extends Base { 32 | protected $map = array( 33 | 'rate' => 'current', 34 | 'rate_max' => 'max', 35 | 'rate_lim' => 'limit', 36 | ); 37 | 38 | /** 39 | * number of sessions per second over last elapsed second 40 | * @var string 41 | */ 42 | public $current; 43 | /** 44 | * max number of new sessions per second 45 | * @var string 46 | */ 47 | public $max; 48 | /** 49 | * limit on new sessions per second 50 | * @var string 51 | */ 52 | public $limit; 53 | } -------------------------------------------------------------------------------- /src/HAProxy/Stats/Service.php: -------------------------------------------------------------------------------- 1 | . 27 | */ 28 | 29 | namespace HAProxy\Stats; 30 | 31 | class Service { 32 | /** 33 | * @var Info 34 | */ 35 | public $info; 36 | /** 37 | * @var Health 38 | */ 39 | public $health; 40 | /** 41 | * @var Queue 42 | */ 43 | public $queue; 44 | /** 45 | * @var Session 46 | */ 47 | public $session; 48 | /** 49 | * @var Bytes 50 | */ 51 | public $bytes; 52 | /** 53 | * @var Rate 54 | */ 55 | public $rate; 56 | /** 57 | * @var Abort 58 | */ 59 | public $abort; 60 | /** 61 | * @var Denied 62 | */ 63 | public $denied; 64 | /** 65 | * @var Error 66 | */ 67 | public $error; 68 | /** 69 | * @var Warning 70 | */ 71 | public $warning; 72 | /** 73 | * @var HttpResponseCode 74 | */ 75 | public $http_response_code; 76 | 77 | /** 78 | * Creates a new Service Stats object from a given status line 79 | * @param Line $line 80 | * @return Service 81 | */ 82 | public static function createFromLine(Line $line) { 83 | $instance = new self(); 84 | $instance->setFromLine($line); 85 | return $instance; 86 | } 87 | 88 | public function setFromLine(Line $line) { 89 | $this->info = new Info($line); 90 | $this->health = new Health($line); 91 | $this->queue = new Queue($line); 92 | $this->session = new Session($line); 93 | $this->bytes = new Bytes($line); 94 | $this->rate = new Rate($line); 95 | $this->abort = new Abort($line); 96 | $this->denied = new Denied($line); 97 | $this->error = new Error($line); 98 | $this->warning = new Warning($line); 99 | $this->http_response_code = new HttpResponseCode($line); 100 | } 101 | 102 | /** 103 | * Returns a string with all the properties of this service 104 | * @return string 105 | */ 106 | public function dump() { 107 | $out = ''; 108 | $out .= $this->info->dump(); 109 | $out .= $this->health->dump(); 110 | $out .= $this->queue->dump(); 111 | $out .= $this->session->dump(); 112 | $out .= $this->bytes->dump(); 113 | $out .= $this->rate->dump(); 114 | $out .= $this->denied->dump(); 115 | $out .= $this->error->dump(); 116 | $out .= $this->warning->dump(); 117 | $out .= $this->http_response_code->dump(); 118 | return $out; 119 | } 120 | } -------------------------------------------------------------------------------- /src/HAProxy/Stats/Session.php: -------------------------------------------------------------------------------- 1 | . 27 | */ 28 | 29 | namespace HAProxy\Stats; 30 | 31 | 32 | class Session extends Base { 33 | protected $map = array( 34 | 'scur' => 'current', 35 | 'smax' => 'max', 36 | 'slim' => 'limit', 37 | ); 38 | 39 | /** 40 | * current sessions 41 | * @var string 42 | */ 43 | public $current; 44 | /** 45 | * max sessions 46 | * @var string 47 | */ 48 | public $max; 49 | /** 50 | * sessions limit 51 | * @var string 52 | */ 53 | public $limit; 54 | /** 55 | * total sessions 56 | * @var string 57 | */ 58 | public $total; 59 | } -------------------------------------------------------------------------------- /src/HAProxy/Stats/Warning.php: -------------------------------------------------------------------------------- 1 | . 27 | */ 28 | 29 | namespace HAProxy\Stats; 30 | 31 | class Warning extends Base { 32 | protected $map = array( 33 | 'wretr' => 'retries', 34 | 'wredis' => 'redispatches', 35 | ); 36 | 37 | /** 38 | * retries (warning) 39 | * @var string 40 | */ 41 | public $retries; 42 | /** 43 | * redispatches (warning) 44 | * @var string 45 | */ 46 | public $redispatches; 47 | } -------------------------------------------------------------------------------- /tests/HAProxy/MockExecutor.php: -------------------------------------------------------------------------------- 1 | getMockStatsData(); 20 | break; 21 | default: 22 | throw new \HAProxy\Exception("Unable to execute command, type unknown: $type"); 23 | break; 24 | } 25 | } 26 | 27 | protected function getMockStatsData() { 28 | static $data = 29 | '# pxname,svname,qcur,qmax,scur,smax,slim,stot,bin,bout,dreq,dresp,ereq,econ,eresp,wretr,wredis,status,weight,act,bck,chkfail,chkdown,lastchg,downtime,qlimit,pid,iid,sid,throttle,lbtot,tracked,type,rate,rate_lim,rate_max,check_status,check_code,check_duration,hrsp_1xx,hrsp_2xx,hrsp_3xx,hrsp_4xx,hrsp_5xx,hrsp_other,hanafail,req_rate,req_rate_max,req_tot,cli_abrt,srv_abrt, 30 | production-proxy,FRONTEND,,,0,876,8192,85528025,44705774510,40817785439,0,0,144247,,,,,OPEN,,,,,,,,,1,1,0,,,,0,1,0,1416,,,,0,84186478,1,1321255,20250,41,,1,1416,85528025,,, 31 | production-nodes,node01.example.com,0,0,0,734,,43005039,22512008349,20543422993,,0,,0,104,780,7,UP,1,1,0,152,53,259322,34439,,1,2,1,,43004259,,2,0,,708,L7OK,200,4,0,42408148,0,593596,0,0,0,,,,90173,104, 32 | production-nodes,node02.example.com,0,0,0,9,,4481,1878931,2106967,,0,,0,1,0,0,UP,1,0,1,157,54,4868,28064,,1,2,2,,4481,,2,0,,33,L7OK,200,22,0,3408,0,1018,54,0,0,,,,0,0, 33 | production-nodes,node03.example.com,0,0,0,538,,42380248,22188916642,20244462235,,0,,0,1870,5260,422,UP,1,1,0,144,54,258985,286925,,1,2,3,,42374997,,2,1,,708,L7OK,200,3,0,41774922,1,582389,0,0,0,,,,94093,90, 34 | production-nodes,node04.example.com,0,0,0,0,,0,0,0,,0,,0,0,0,0,UP,1,0,1,155,50,258985,289563,,1,2,4,,0,,2,0,,0,L7OK,200,22,0,0,0,0,0,0,0,,,,0,0, 35 | production-nodes,BACKEND,0,0,0,875,0,85383733,44703010797,40790082295,0,0,,425,1976,6040,429,UP,2,2,2,,4,620646,39,,1,2,0,,85383737,,1,1,,1416,,,,0,84186478,1,1177003,20250,1,,,,,184266,194, 36 | stats,FRONTEND,,,1,2,2000,2634,1039226,13621484,0,0,150,,,,,OPEN,,,,,,,,,1,3,0,,,,0,1,0,13,,,,0,1221,368,200,844,0,,1,13,2634,,, 37 | stats,BACKEND,0,0,0,1,2000,844,1039226,13621484,0,0,,844,0,0,0,UP,0,0,0,,0,29145982,0,,1,3,0,,0,,1,0,,13,,,,0,0,0,0,844,0,,,,,0,0,'; 38 | // Normalizing line feeds 39 | return preg_replace('/[\n\r]+/', "\n", $data); 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /tests/HAProxy/StatsFunctionalHttpTest.php: -------------------------------------------------------------------------------- 1 | markTestSkipped("The functional tests are only run in Docker"); 15 | } 16 | } 17 | 18 | public function testStatsInstantiate() { 19 | $exec = new Executor($this->host, $this->type); 20 | $exec->setCredentials($this->username, $this->password); 21 | $stats = Stats::get($exec); 22 | 23 | $tree = $stats->getTree(); 24 | $backends = implode(";", array_keys($tree)); 25 | $this->assertEquals("unit-testing;local-backend;stats", $backends); 26 | 27 | $server = $stats->getServiceStats("local-backend","server1"); 28 | 29 | $this->assertInstanceOf("HAProxy\\Stats\\Info", $server->info); 30 | $this->assertInstanceOf("HAProxy\\Stats\\Health", $server->health); 31 | $this->assertInstanceOf("HAProxy\\Stats\\Queue", $server->queue); 32 | $this->assertInstanceOf("HAProxy\\Stats\\Session", $server->session); 33 | $this->assertInstanceOf("HAProxy\\Stats\\Bytes", $server->bytes); 34 | $this->assertInstanceOf("HAProxy\\Stats\\Rate", $server->rate); 35 | $this->assertInstanceOf("HAProxy\\Stats\\Abort", $server->abort); 36 | $this->assertInstanceOf("HAProxy\\Stats\\Denied", $server->denied); 37 | $this->assertInstanceOf("HAProxy\\Stats\\Error", $server->error); 38 | $this->assertInstanceOf("HAProxy\\Stats\\Warning", $server->warning); 39 | $this->assertInstanceOf("HAProxy\\Stats\\HttpResponseCode", $server->http_response_code); 40 | } 41 | 42 | public function testProxyValues() { 43 | $exec = new Executor($this->host, $this->type); 44 | $exec->setCredentials($this->username, $this->password); 45 | $stats = Stats::get($exec); 46 | $proxy = $stats->getServiceStats("unit-testing", "FRONTEND"); 47 | 48 | // Use these to see the actual values 49 | // echo $proxy->dump(); 50 | 51 | $this->assertTrue($proxy->info->isFrontend()); 52 | $this->assertEquals("OPEN", $proxy->health->status); 53 | $this->assertEquals("0", $proxy->bytes->in); 54 | $this->assertEquals("0", $proxy->rate->max); 55 | } 56 | 57 | public function testServerValues() { 58 | $exec = new Executor($this->host, $this->type); 59 | $exec->setCredentials($this->username, $this->password); 60 | $stats = Stats::get($exec); 61 | $server = $stats->getServiceStats("local-backend","server1"); 62 | 63 | // Use these to see the actual values 64 | // echo $server->dump(); 65 | 66 | $this->assertTrue($server->info->isServer()); 67 | $this->assertEquals("no check", $server->health->status); 68 | $this->assertEquals("0", $server->http_response_code->http_4xx); 69 | $this->assertEquals("0", $server->warning->redispatches); 70 | } 71 | 72 | } 73 | 74 | -------------------------------------------------------------------------------- /tests/HAProxy/StatsFunctionalSocketTest.php: -------------------------------------------------------------------------------- 1 | exec = new MockExecutor(); 11 | } 12 | 13 | public function testStatsInstantiate() { 14 | $stats = Stats::get($this->exec); 15 | 16 | $tree = $stats->getTree(); 17 | $backends = implode(';', array_keys($tree)); 18 | $this->assertEquals('production-proxy;production-nodes;stats', $backends); 19 | 20 | $server = $stats->getServiceStats('production-nodes','node03.example.com'); 21 | 22 | $this->assertInstanceOf('HAProxy\\Stats\\Info', $server->info); 23 | $this->assertInstanceOf('HAProxy\\Stats\\Health', $server->health); 24 | $this->assertInstanceOf('HAProxy\\Stats\\Queue', $server->queue); 25 | $this->assertInstanceOf('HAProxy\\Stats\\Session', $server->session); 26 | $this->assertInstanceOf('HAProxy\\Stats\\Bytes', $server->bytes); 27 | $this->assertInstanceOf('HAProxy\\Stats\\Rate', $server->rate); 28 | $this->assertInstanceOf('HAProxy\\Stats\\Abort', $server->abort); 29 | $this->assertInstanceOf('HAProxy\\Stats\\Denied', $server->denied); 30 | $this->assertInstanceOf('HAProxy\\Stats\\Error', $server->error); 31 | $this->assertInstanceOf('HAProxy\\Stats\\Warning', $server->warning); 32 | $this->assertInstanceOf('HAProxy\\Stats\\HttpResponseCode', $server->http_response_code); 33 | } 34 | 35 | public function testProxyValues() { 36 | $stats = Stats::get($this->exec); 37 | $proxy = $stats->getServiceStats('production-proxy', 'FRONTEND'); 38 | 39 | // Use these to see the actual values 40 | // echo $proxy->dump(); 41 | 42 | $this->assertTrue($proxy->info->isFrontend()); 43 | $this->assertEquals('OPEN', $proxy->health->status); 44 | $this->assertEquals('44705774510', $proxy->bytes->in); 45 | $this->assertEquals('1416', $proxy->rate->max); 46 | } 47 | 48 | public function testServerValues() { 49 | $stats = Stats::get($this->exec); 50 | $server = $stats->getServiceStats('production-nodes','node03.example.com'); 51 | 52 | // Use these to see the actual values 53 | // echo $server->dump(); 54 | 55 | $this->assertTrue($server->info->isServer()); 56 | $this->assertEquals('UP', $server->health->status); 57 | $this->assertEquals('582389', $server->http_response_code->http_4xx); 58 | $this->assertEquals('422', $server->warning->redispatches); 59 | } 60 | 61 | 62 | protected function tearDown() { 63 | $this->exec = null; 64 | } 65 | } 66 | 67 | -------------------------------------------------------------------------------- /tests/bootstrap.php: -------------------------------------------------------------------------------- 1 | /dev/null 2>&1 || /bin/true 10 | docker rm -vf $CONTAINER >/dev/null 2>&1 || /bin/true 11 | } 12 | 13 | for HAPROXY_VERSION in $HAPROXY_VERSIONS; do 14 | 15 | echo "Removing old test containers" 16 | CONFIG="$DIR/haproxy-$HAPROXY_VERSION.cfg" 17 | HAPROXY="haproxyapi-haproxy-$HAPROXY_VERSION" 18 | 19 | kill_and_remove "$HAPROXY" 20 | 21 | echo "Starting HAProxy $HAPROXY_VERSION" 22 | docker run \ 23 | --name="$HAPROXY" \ 24 | -d \ 25 | -v $CONFIG:/usr/local/etc/haproxy/haproxy.cfg \ 26 | -v /tmp \ 27 | -p "10010" \ 28 | -p "10000" \ 29 | haproxy:$HAPROXY_VERSION 30 | 31 | for PHP_VERSION in $PHP_VERSIONS; do 32 | echo "Running unit tests in $PHP_VERSION against HAProxy $HAPROXY_VERSION" 33 | docker run \ 34 | --rm \ 35 | --link="$HAPROXY:haproxy" \ 36 | --volumes-from="$HAPROXY" \ 37 | --workdir="/u/apps/site" \ 38 | -v "$DIR/../../:/u/apps/site:ro" \ 39 | $PHP_VERSION \ 40 | vendor/bin/phpunit -vvvv 41 | done 42 | 43 | done 44 | 45 | echo "Cleaning up containers" 46 | kill_and_remove "$HAPROXY" 47 | --------------------------------------------------------------------------------