├── .gitignore ├── .travis.yml ├── LICENSE ├── README.md ├── docker-compose.yml ├── docker ├── php │ ├── Dockerfile │ └── docker-php-ext-opcache.ini └── python │ ├── Dockerfile │ └── requirements.txt └── php_opcache_exporter.py /.gitignore: -------------------------------------------------------------------------------- 1 | venv 2 | tmp 3 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | # Disable sudo to speed up the build 2 | sudo: false 3 | 4 | language: python 5 | 6 | python: 7 | - "2.7" 8 | 9 | # command to install dependencies 10 | install: "pip install -r docker/python/requirements.txt" 11 | 12 | # command to run tests 13 | script: 14 | # check syntax 15 | - python -m py_compile php_opcache_exporter.py 16 | # code coverage 17 | # - coverage run php_opcache_exporter.py 18 | 19 | #after_success: 20 | # - codecov 21 | 22 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # PHP OPcache exporter 2 | 3 | ## Overview 4 | 5 | prometheus exporter for PHP OPcache stats, written in python. 6 | 7 | 8 | 9 | integration for discovery a send prometheus metrics to zabbix 10 | 11 | ## Description 12 | 13 | Data is fetched from [opcache_get_status()](http://php.net/manual/en/function.opcache-get-status.php) function. 14 | 15 | FastCGi variant was tested on CentOS 7 with php-fpm 7.1. 16 | 17 | scprape-uri varianta tested with docker and owncloud docker stack. 18 | 19 | ## Usage 20 | 21 | You can just use "--scrape_uri" for scraping from URL/URI or use fast-cgi client 22 | 23 | Help on flags: 24 | 25 |
26 | usage: php_opcache_exporter.py [-h] [-p port] [--scrape_uri SCRAPE_URI]
27 |                                [--fhost FHOST] [--phpfile phpfile]
28 |                                [--phpcontent phpcontent] [--phpcode phpcode]
29 |                                [--fport FPORT]
30 | 
31 | php_opcache_exporter args
32 | 
33 | optional arguments:
34 |   -h, --help            show this help message and exit
35 |   -p port, --port port  Listen to this port
36 |   --scrape_uri SCRAPE_URI
37 |                         URL for scraping, such as http://127.0.0.1/opcache-
38 |                         status.php
39 |   --fhost FHOST         Target FastCGI host, such as 127.0.0.1
40 |   --phpfile phpfile     A php file absolute path, such as
41 |                         /usr/local/lib/php/System.php
42 |   --phpcontent phpcontent
43 |                         http get params, such as name=john&address=beijing
44 |   --phpcode phpcode     code for execution over fastcgi client
45 |   --fport FPORT         FastCGI port
46 | 
47 | 48 | ## Author(s) 49 | 50 | * Patrik Majer (@czhujer) 51 | 52 | ## Docs 53 | 54 | * https://prometheus.io/docs/concepts/metric_types/ 55 | 56 | * https://prometheus.io/docs/instrumenting/writing_exporters/ 57 | 58 | * https://github.com/prometheus/client_python 59 | 60 | * https://github.com/RobustPerception/python_examples/tree/master/jenkins_exporter 61 | 62 | * https://github.com/lovoo/jenkins_exporter 63 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '3' 2 | services: 3 | php: 4 | build: 5 | context: ./docker/php 6 | volumes: 7 | - ./docker/php/docker-php-ext-opcache.ini:/usr/local/etc/php/conf.d/docker-php-ext-opcache.ini 8 | - tmp:/tmp 9 | ports: 10 | - 9000:9000 11 | 12 | python: 13 | build: 14 | context: . 15 | dockerfile: Dockerfile 16 | image: czhujer/php-opcache-exporter:v0.4.1 17 | ports: 18 | - 9462:9462 19 | command: python php_opcache_exporter.py --fhost php 20 | volumes: 21 | - ./:/app 22 | - tmp:/tmp 23 | 24 | volumes: 25 | tmp: 26 | -------------------------------------------------------------------------------- /docker/php/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM php:7.2-fpm 2 | LABEL maintainer="Narate Ketram " 3 | RUN docker-php-ext-install opcache && docker-php-ext-enable opcache 4 | -------------------------------------------------------------------------------- /docker/php/docker-php-ext-opcache.ini: -------------------------------------------------------------------------------- 1 | zend_extension=/usr/local/lib/php/extensions/no-debug-non-zts-20170718/opcache.so 2 | ; Sets how much memory to use 3 | opcache.memory_consumption=128 4 | 5 | ;Sets how much memory should be used by OPcache for storing internal strings 6 | ;(e.g. classnames and the files they are contained in) 7 | opcache.interned_strings_buffer=8 8 | 9 | ; The maximum number of files OPcache will cache 10 | opcache.max_accelerated_files=4000 11 | 12 | ;How often (in seconds) to check file timestamps for changes to the shared 13 | ;memory storage allocation. 14 | opcache.revalidate_freq=60 15 | 16 | ;If enabled, a fast shutdown sequence is used for the accelerated code 17 | ;The fast shutdown sequence doesn't free each allocated block, but lets 18 | ;the Zend Engine Memory Manager do the work. 19 | opcache.fast_shutdown=1 20 | 21 | ;Enables the OPcache for the CLI version of PHP. 22 | opcache.enable_cli=1 23 | -------------------------------------------------------------------------------- /docker/python/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM python:2-alpine 2 | LABEL maintainer="Narate Ketram " 3 | WORKDIR /app 4 | ADD ./docker/python/requirements.txt . 5 | RUN pip install -r requirements.txt 6 | ADD ./php_opcache_exporter.py . 7 | EXPOSE 9462 8 | CMD ["python", "php_opcache_exporter.py"] 9 | -------------------------------------------------------------------------------- /docker/python/requirements.txt: -------------------------------------------------------------------------------- 1 | prometheus_client 2 | requests 3 | codecov 4 | 5 | -------------------------------------------------------------------------------- /php_opcache_exporter.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | 3 | import re 4 | import time 5 | import requests 6 | import argparse 7 | from pprint import pprint 8 | 9 | import os 10 | from sys import exit 11 | from prometheus_client import start_http_server, Summary 12 | from prometheus_client.core import GaugeMetricFamily, REGISTRY 13 | 14 | import socket 15 | import random 16 | import sys 17 | from io import BytesIO 18 | import tempfile 19 | 20 | import json 21 | 22 | DEBUG = int(os.environ.get('DEBUG', '0')) 23 | DEBUG2 = int(os.environ.get('DEBUG2', '0')) 24 | 25 | COLLECTION_TIME = Summary('php_opcache_collector_collect_seconds', 'Time spent to collect metrics from PHP OPcache') 26 | 27 | PY2 = True if sys.version_info.major == 2 else False 28 | 29 | def bchr(i): 30 | if PY2: 31 | return force_bytes(chr(i)) 32 | else: 33 | return bytes([i]) 34 | 35 | def bord(c): 36 | if isinstance(c, int): 37 | return c 38 | else: 39 | return ord(c) 40 | 41 | def force_bytes(s): 42 | if isinstance(s, bytes): 43 | return s 44 | else: 45 | return s.encode('utf-8', 'strict') 46 | 47 | def force_text(s): 48 | if issubclass(type(s), str): 49 | return s 50 | if isinstance(s, bytes): 51 | s = str(s, 'utf-8', 'strict') 52 | else: 53 | s = str(s) 54 | return s 55 | 56 | def UmaskNamedTemporaryFile(*args, **kargs): 57 | fdesc = tempfile.NamedTemporaryFile(*args, **kargs) 58 | umask = os.umask(0) 59 | os.umask(umask) 60 | os.chmod(fdesc.name, 0o666 & ~umask) 61 | return fdesc 62 | 63 | class OpcacheCollector(object): 64 | 65 | def __init__(self, scrape_uri, phpcode, phpcontent, fhost, fport): 66 | self._scrape_uri = scrape_uri 67 | self._phpcode = phpcode 68 | self._phpcontent = phpcontent 69 | self._fhost = fhost 70 | self._fport = fport 71 | 72 | def collect(self): 73 | start = time.time() 74 | 75 | # The metrics we want to export about. 76 | items = ["opcache_enabled", "cache_full", "restart_in_progress", "restart_pending", 77 | "interned_strings_usage", "memory_usage", "opcache_statistics", 78 | ] 79 | 80 | items2 = ["used_memory", "buffer_size", "number_of_strings", "free_memory"] 81 | 82 | items3 = ["used_memory", "wasted_memory", "current_wasted_percentage", "free_memory"] 83 | 84 | items4 = ["hits", "blacklist_miss_ratio", "max_cached_keys", "manual_restarts", 85 | "num_cached_keys", "opcache_hit_rate", "last_restart_time", "start_time", 86 | "misses", "oom_restarts", "num_cached_scripts", "blacklist_misses", "hash_restarts"] 87 | 88 | # The metrics we want to export. 89 | metrics = { 90 | 'opcache_enabled': 91 | GaugeMetricFamily('php_opcache_opcache_enabled', 'PHP OPcache opcache_enabled'), 92 | 'cache_full': 93 | GaugeMetricFamily('php_opcache_cache_full', 'PHP OPcache cache_full'), 94 | 'restart_in_progress': 95 | GaugeMetricFamily('php_opcache_restart_in_progress', 'PHP OPcache restart_in_progress'), 96 | 'restart_pending': 97 | GaugeMetricFamily('php_opcache_restart_pending', 'PHP OPcache restart_pending'), 98 | 'interned_strings_usage_used_memory': 99 | GaugeMetricFamily('php_opcache_interned_strings_usage_used_memory', 'PHP OPcache interned_strings_usage used_memory'), 100 | 'interned_strings_usage_buffer_size': 101 | GaugeMetricFamily('php_opcache_interned_strings_usage_buffer_size', 'PHP OPcache interned_strings_usage buffer_size'), 102 | 'interned_strings_usage_number_of_strings': 103 | GaugeMetricFamily('php_opcache_interned_strings_usage_number_of_strings', 'PHP OPcache interned_strings_usage number_of_strings'), 104 | 'interned_strings_usage_free_memory': 105 | GaugeMetricFamily('php_opcache_interned_strings_usage_free_memory', 'PHP OPcache interned_strings_usage free_memory'), 106 | 'memory_usage_used_memory': 107 | GaugeMetricFamily('php_opcache_memory_usage_used_memory', 'PHP OPcache memory_usage used_memory'), 108 | 'memory_usage_wasted_memory': 109 | GaugeMetricFamily('php_opcache_memory_usage_wasted_memory', 'PHP OPcache memory_usage wasted_memory'), 110 | 'memory_usage_current_wasted_percentage': 111 | GaugeMetricFamily('php_opcache_memory_usage_current_wasted_percentage', 'PHP OPcache memory_usage current_wasted_percentage'), 112 | 'memory_usage_free_memory': 113 | GaugeMetricFamily('php_opcache_memory_usage_free_memory', 'PHP OPcache memory_usage free_memory'), 114 | 'opcache_statistics_hits': 115 | GaugeMetricFamily('opcache_statistics_hits', 'PHP OPcache opcache_statistics hits'), 116 | 'opcache_statistics_blacklist_miss_ratio': 117 | GaugeMetricFamily('opcache_statistics_blacklist_miss_ratio', 'PHP OPcache opcache_statistics blacklist_miss_ratio'), 118 | 'opcache_statistics_max_cached_keys': 119 | GaugeMetricFamily('opcache_statistics_max_cached_keys', 'PHP OPcache opcache_statistics max_cached_keys'), 120 | 'opcache_statistics_manual_restarts': 121 | GaugeMetricFamily('opcache_statistics_manual_restarts', 'PHP OPcache opcache_statistics manual_restarts'), 122 | 'opcache_statistics_num_cached_keys': 123 | GaugeMetricFamily('opcache_statistics_num_cached_keys', 'PHP OPcache opcache_statistics num_cached_keys'), 124 | 'opcache_statistics_opcache_hit_rate': 125 | GaugeMetricFamily('opcache_statistics_opcache_hit_rate', 'PHP OPcache opcache_statistics opcache_hit_rate'), 126 | 'opcache_statistics_last_restart_time': 127 | GaugeMetricFamily('opcache_statistics_last_restart_time', 'PHP OPcache opcache_statistics last_restart_time'), 128 | 'opcache_statistics_start_time': 129 | GaugeMetricFamily('opcache_statistics_start_time', 'PHP OPcache opcache_statistics start_time'), 130 | 'opcache_statistics_misses': 131 | GaugeMetricFamily('opcache_statistics_misses', 'PHP OPcache opcache_statistics misses'), 132 | 'opcache_statistics_oom_restarts': 133 | GaugeMetricFamily('opcache_statistics_oom_restarts', 'PHP OPcache opcache_statistics oom_restarts'), 134 | 'opcache_statistics_num_cached_scripts': 135 | GaugeMetricFamily('opcache_statistics_num_cached_scripts', 'PHP OPcache opcache_statistics num_cached_scripts'), 136 | 'opcache_statistics_blacklist_misses': 137 | GaugeMetricFamily('opcache_statistics_blacklist_misses', 'PHP OPcache opcache_statistics blacklist_misses'), 138 | 'opcache_statistics_hash_restarts': 139 | GaugeMetricFamily('opcache_statistics_hash_restarts', 'PHP OPcache opcache_statistics hash_restarts'), 140 | } 141 | 142 | # Request data from PHP Opcache 143 | if self._scrape_uri: 144 | values = self._request_data_over_url() 145 | else: 146 | values = self._request_data() 147 | 148 | values_json = json.loads(values) 149 | 150 | # filter metrics and transform into array 151 | for key in values_json: 152 | value = values_json[key] 153 | if key != "scripts": 154 | if DEBUG2: 155 | print("The key and value are ({}) = ({})".format(key, value)) 156 | if key in items: 157 | if value == True: 158 | metrics[key].add_metric('',1) 159 | elif value == False: 160 | metrics[key].add_metric('',0) 161 | elif type(value) is dict: 162 | if re.match('^interned_strings.*', key) is not None: 163 | for key2 in value: 164 | if key2 in items2: 165 | #print("The key and value are ({}) = ({})".format(key2, value[key2])) 166 | key2_c = key.encode('ascii') + "_" + key2.encode('ascii') 167 | metrics[key2_c].add_metric('',value[key2]) 168 | elif re.match('^memory_usage.*', key) is not None: 169 | for key3 in value: 170 | if key3 in items3: 171 | #print("The key and value are ({}) = ({})".format(key3, value[key3])) 172 | key3_c = key.encode('ascii') + "_" + key3.encode('ascii') 173 | metrics[key3_c].add_metric('',value[key3]) 174 | elif re.match('^opcache_statistics.*', key) is not None: 175 | for key4 in value: 176 | if key4 in items4: 177 | #print("The key and value are ({}) = ({})".format(key4, value[key4])) 178 | key4_c = key.encode('ascii') + "_" + key4.encode('ascii') 179 | metrics[key4_c].add_metric('',value[key4]) 180 | else: 181 | metrics[key].add_metric('',value) 182 | 183 | for i in metrics: 184 | yield metrics[i] 185 | 186 | duration = time.time() - start 187 | COLLECTION_TIME.observe(duration) 188 | 189 | def _request_data_over_url(self): 190 | # Request exactly the information we need from Opcache 191 | 192 | r = requests.get(self._scrape_uri) 193 | 194 | if r.status_code != 200: 195 | print "ERROR: status code from scrape-url is wrong (" + str(r.status_code) + ")" 196 | exit(14) 197 | 198 | text = r.text 199 | if len(text) > 0: 200 | return text 201 | else: 202 | print "ERROR: response for scrape-url is empty" 203 | exit(13) 204 | 205 | def _request_data(self): 206 | # Request exactly the information we need from Opcache 207 | 208 | #make tmpfile with php code 209 | tmpfile = UmaskNamedTemporaryFile(suffix='.php') 210 | with open(tmpfile.name, 'w') as f: 211 | f.write(self._phpcode) 212 | 213 | #get php content 214 | client = FastCGIClient(self._fhost, self._fport, 3, 0) 215 | params = dict() 216 | documentRoot = "/tmp" 217 | uri = tmpfile.name 218 | scriptname = uri.replace('/tmp','',1) 219 | content = self._phpcontent 220 | params = { 221 | 'GATEWAY_INTERFACE': 'FastCGI/1.0', 222 | 'REQUEST_METHOD': 'POST', 223 | 'SCRIPT_FILENAME': uri, 224 | 'SCRIPT_NAME': scriptname, 225 | 'QUERY_STRING': '', 226 | 'REQUEST_URI': scriptname, 227 | 'DOCUMENT_ROOT': documentRoot, 228 | 'SERVER_SOFTWARE': 'php/fcgiclient', 229 | 'REMOTE_ADDR': '127.0.0.1', 230 | 'REMOTE_PORT': '9985', 231 | 'SERVER_ADDR': '127.0.0.1', 232 | 'SERVER_PORT': '80', 233 | 'SERVER_NAME': "localhost", 234 | 'SERVER_PROTOCOL': 'HTTP/1.1', 235 | 'CONTENT_TYPE': 'application/text', 236 | 'CONTENT_LENGTH': "%d" % len(content), 237 | 'PHP_VALUE': 'auto_prepend_file = php://input', 238 | 'PHP_ADMIN_VALUE': 'allow_url_include = On' 239 | } 240 | response = client.request(params, content) 241 | if DEBUG: 242 | print "params: " 243 | print params 244 | print "response:" 245 | print(force_text(response)) 246 | 247 | if not response: 248 | print "ERROR: response for fastcgi call is empty" 249 | exit(2) 250 | 251 | response_body = "\n".join(response.split("\n")[3:]) 252 | response_force_text = force_text(response_body) 253 | 254 | if DEBUG: 255 | print "converted response:" 256 | print(response_force_text) 257 | 258 | return response_body 259 | 260 | class FastCGIClient: 261 | # Referrer: https://github.com/wuyunfeng/Python-FastCGI-Client 262 | # Referrer: https://gist.github.com/phith0n/9615e2420f31048f7e30f3937356cf75 263 | """A Fast-CGI Client for Python""" 264 | 265 | # private 266 | __FCGI_VERSION = 1 267 | 268 | __FCGI_ROLE_RESPONDER = 1 269 | __FCGI_ROLE_AUTHORIZER = 2 270 | __FCGI_ROLE_FILTER = 3 271 | 272 | __FCGI_TYPE_BEGIN = 1 273 | __FCGI_TYPE_ABORT = 2 274 | __FCGI_TYPE_END = 3 275 | __FCGI_TYPE_PARAMS = 4 276 | __FCGI_TYPE_STDIN = 5 277 | __FCGI_TYPE_STDOUT = 6 278 | __FCGI_TYPE_STDERR = 7 279 | __FCGI_TYPE_DATA = 8 280 | __FCGI_TYPE_GETVALUES = 9 281 | __FCGI_TYPE_GETVALUES_RESULT = 10 282 | __FCGI_TYPE_UNKOWNTYPE = 11 283 | 284 | __FCGI_HEADER_SIZE = 8 285 | 286 | # request state 287 | FCGI_STATE_SEND = 1 288 | FCGI_STATE_ERROR = 2 289 | FCGI_STATE_SUCCESS = 3 290 | 291 | def __init__(self, host, port, timeout, keepalive): 292 | self.host = host 293 | self.port = port 294 | self.timeout = timeout 295 | if keepalive: 296 | self.keepalive = 1 297 | else: 298 | self.keepalive = 0 299 | self.sock = None 300 | self.requests = dict() 301 | 302 | def __connect(self): 303 | self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) 304 | self.sock.settimeout(self.timeout) 305 | self.sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) 306 | # if self.keepalive: 307 | # self.sock.setsockopt(socket.SOL_SOCKET, socket.SOL_KEEPALIVE, 1) 308 | # else: 309 | # self.sock.setsockopt(socket.SOL_SOCKET, socket.SOL_KEEPALIVE, 0) 310 | try: 311 | self.sock.connect((self.host, int(self.port))) 312 | except socket.error as msg: 313 | self.sock.close() 314 | self.sock = None 315 | print(repr(msg)) 316 | return False 317 | return True 318 | 319 | def __encodeFastCGIRecord(self, fcgi_type, content, requestid): 320 | length = len(content) 321 | buf = bchr(FastCGIClient.__FCGI_VERSION) \ 322 | + bchr(fcgi_type) \ 323 | + bchr((requestid >> 8) & 0xFF) \ 324 | + bchr(requestid & 0xFF) \ 325 | + bchr((length >> 8) & 0xFF) \ 326 | + bchr(length & 0xFF) \ 327 | + bchr(0) \ 328 | + bchr(0) \ 329 | + content 330 | return buf 331 | 332 | def __encodeNameValueParams(self, name, value): 333 | nLen = len(name) 334 | vLen = len(value) 335 | record = b'' 336 | if nLen < 128: 337 | record += bchr(nLen) 338 | else: 339 | record += bchr((nLen >> 24) | 0x80) \ 340 | + bchr((nLen >> 16) & 0xFF) \ 341 | + bchr((nLen >> 8) & 0xFF) \ 342 | + bchr(nLen & 0xFF) 343 | if vLen < 128: 344 | record += bchr(vLen) 345 | else: 346 | record += bchr((vLen >> 24) | 0x80) \ 347 | + bchr((vLen >> 16) & 0xFF) \ 348 | + bchr((vLen >> 8) & 0xFF) \ 349 | + bchr(vLen & 0xFF) 350 | return record + name + value 351 | 352 | def __decodeFastCGIHeader(self, stream): 353 | header = dict() 354 | header['version'] = bord(stream[0]) 355 | header['type'] = bord(stream[1]) 356 | header['requestId'] = (bord(stream[2]) << 8) + bord(stream[3]) 357 | header['contentLength'] = (bord(stream[4]) << 8) + bord(stream[5]) 358 | header['paddingLength'] = bord(stream[6]) 359 | header['reserved'] = bord(stream[7]) 360 | return header 361 | 362 | def __decodeFastCGIRecord(self, buffer): 363 | header = buffer.read(int(self.__FCGI_HEADER_SIZE)) 364 | 365 | if not header: 366 | return False 367 | else: 368 | record = self.__decodeFastCGIHeader(header) 369 | record['content'] = b'' 370 | 371 | if 'contentLength' in record.keys(): 372 | contentLength = int(record['contentLength']) 373 | record['content'] += buffer.read(contentLength) 374 | if 'paddingLength' in record.keys(): 375 | skiped = buffer.read(int(record['paddingLength'])) 376 | return record 377 | 378 | def request(self, nameValuePairs={}, post=''): 379 | if not self.__connect(): 380 | print('connect failure! please check your fasctcgi-server !!') 381 | return 382 | 383 | requestId = random.randint(1, (1 << 16) - 1) 384 | self.requests[requestId] = dict() 385 | request = b"" 386 | beginFCGIRecordContent = bchr(0) \ 387 | + bchr(FastCGIClient.__FCGI_ROLE_RESPONDER) \ 388 | + bchr(self.keepalive) \ 389 | + bchr(0) * 5 390 | request += self.__encodeFastCGIRecord(FastCGIClient.__FCGI_TYPE_BEGIN, 391 | beginFCGIRecordContent, requestId) 392 | paramsRecord = b'' 393 | if nameValuePairs: 394 | for (name, value) in nameValuePairs.items(): 395 | name = force_bytes(name) 396 | value = force_bytes(value) 397 | paramsRecord += self.__encodeNameValueParams(name, value) 398 | 399 | if paramsRecord: 400 | request += self.__encodeFastCGIRecord(FastCGIClient.__FCGI_TYPE_PARAMS, paramsRecord, requestId) 401 | request += self.__encodeFastCGIRecord(FastCGIClient.__FCGI_TYPE_PARAMS, b'', requestId) 402 | 403 | if post: 404 | request += self.__encodeFastCGIRecord(FastCGIClient.__FCGI_TYPE_STDIN, force_bytes(post), requestId) 405 | request += self.__encodeFastCGIRecord(FastCGIClient.__FCGI_TYPE_STDIN, b'', requestId) 406 | 407 | self.sock.send(request) 408 | self.requests[requestId]['state'] = FastCGIClient.FCGI_STATE_SEND 409 | self.requests[requestId]['response'] = b'' 410 | return self.__waitForResponse(requestId) 411 | 412 | def __waitForResponse(self, requestId): 413 | data = b'' 414 | while True: 415 | buf = self.sock.recv(512) 416 | if not len(buf): 417 | break 418 | data += buf 419 | 420 | data = BytesIO(data) 421 | while True: 422 | response = self.__decodeFastCGIRecord(data) 423 | if not response: 424 | break 425 | if response['type'] == FastCGIClient.__FCGI_TYPE_STDOUT \ 426 | or response['type'] == FastCGIClient.__FCGI_TYPE_STDERR: 427 | if response['type'] == FastCGIClient.__FCGI_TYPE_STDERR: 428 | self.requests['state'] = FastCGIClient.FCGI_STATE_ERROR 429 | if requestId == int(response['requestId']): 430 | self.requests[requestId]['response'] += response['content'] 431 | if response['type'] == FastCGIClient.FCGI_STATE_SUCCESS: 432 | self.requests[requestId] 433 | return self.requests[requestId]['response'] 434 | 435 | def __repr__(self): 436 | return "fastcgi connect host:{} port:{}".format(self.host, self.port) 437 | 438 | 439 | def parse_args(): 440 | parser = argparse.ArgumentParser( 441 | description='php_opcache_exporter args' 442 | ) 443 | parser.add_argument( 444 | '-p', '--port', 445 | metavar='port', 446 | required=False, 447 | type=int, 448 | help='Listen to this port', 449 | default=int(os.environ.get('VIRTUAL_PORT', '9462')) 450 | ) 451 | parser.add_argument( 452 | '--scrape_uri', 453 | help='URL for scraping, such as http://127.0.0.1/opcache-status.php', 454 | ) 455 | parser.add_argument( 456 | '--fhost', 457 | help='Target FastCGI host, such as 127.0.0.1', 458 | default='127.0.0.1' 459 | ) 460 | parser.add_argument( 461 | '--phpfile', 462 | metavar='phpfile', 463 | help='A php file absolute path, such as /usr/local/lib/php/System.php', 464 | default='' 465 | ) 466 | parser.add_argument( 467 | '--phpcontent', 468 | metavar='phpcontent', 469 | help='http get params, such as name=john&address=beijing', 470 | default='' 471 | ) 472 | parser.add_argument( 473 | '--phpcode', 474 | metavar='phpcode', 475 | help='code for execution over fastcgi client', 476 | default='' 477 | ) 478 | parser.add_argument( 479 | '--fport', 480 | help='FastCGI port', 481 | default=9000, 482 | type=int 483 | ) 484 | 485 | return parser.parse_args() 486 | 487 | 488 | def main(): 489 | try: 490 | args = parse_args() 491 | port = int(args.port) 492 | REGISTRY.register(OpcacheCollector(args.scrape_uri, args.phpcode, args.phpcontent, args.fhost, args.fport)) 493 | start_http_server(port) 494 | print("Polling... Serving at port: {}".format(args.port)) 495 | while True: 496 | time.sleep(1) 497 | except KeyboardInterrupt: 498 | print(" Interrupted") 499 | exit(0) 500 | 501 | if __name__ == "__main__": 502 | main() 503 | --------------------------------------------------------------------------------