├── .gitignore ├── LICENSE ├── README.markdown ├── WHATSNEW ├── nanomon ├── nanomon.conf └── tests ├── Makefile ├── basic_config ├── swapfailure_config └── test_basic.py /.gitignore: -------------------------------------------------------------------------------- 1 | toserver 2 | -------------------------------------------------------------------------------- /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.markdown: -------------------------------------------------------------------------------- 1 | nanomon: Extremely Lightweight Monitoring System 2 | ================================================ 3 | 4 | Overview 5 | -------- 6 | 7 | [nanomon](http://www.tummy.com/software/nanomon/) is an extremely small 8 | and simple monitoring system meant largely for reporting on a few systems 9 | such as reporting failures on RAID arrays, ZFS volums, or file-systems 10 | don't fill up. It's meant to be similar to a simple "check" script that 11 | one may write, but with the additional features: 12 | 13 | * Checks several times, so a transient failure does not result in an alert. 14 | * Remembers state so that a failure doesn't generate mail with every check. 15 | * Can check multiple issues from a single instance. 16 | 17 | It's meant to be a *much* simpler system than things like OpsView (which 18 | we use in our data center), Zenoss, or Zabbix, without the learning-curve 19 | of nagios (which most of the others listed above use under the hood). 20 | nanomon was written after I had spent nearly a week trying to get the 21 | other solutions working. 22 | 23 | nanomon uses "cron" or it's own scheduler for the scheduling, and is a 24 | single program executable. nanomon runs external programs (as specified 25 | in the config file), which can be simple commands or shell scripts 26 | and determines success or failure by either exit code, string match, 27 | or Python function (including regular expression match). 28 | 29 | Cron or Daemon Mode 30 | ------------------- 31 | 32 | Probably the simplest way to deploy nanomon is to run it from cron every 33 | minute. However, you can also run it in "daemon" mode, which allows you to 34 | run the checks on a different schedule than every minute. This would allow 35 | you to run checks every 15 seconds or every 90 seconds, for example. 36 | 37 | Note, however, that nanomon does not run checks in parallel. If you have 38 | 10 checks that each could take 10 seconds before timing out, the check 39 | frequency could be extended to 100 seconds. 40 | 41 | The scheduler tries to start a round of checks "`--interval`" seconds after 42 | the start of the previous set of checks. However, if the previous set of 43 | checks took longer than "`--interval`", the checks will start after 44 | "`--min-interval`" seconds (default 0) after the last set of checks finished. 45 | "`--min-interval`" allows you to set a minimum interval between checks. 46 | 47 | Download 48 | -------- 49 | 50 | Download from: 51 | 52 | * [tummy.com FTP server](http://ftp.tummy.com/pub/tummy/nanomon/) 53 | * [github Repository/Tracker](https://github.com/linsomniac/nanomon) 54 | 55 | Bugs 56 | ---- 57 | 58 | Please report any bugs on the 59 | [github Tracker](https://github.com/linsomniac/nanomon) 60 | 61 | Examples 62 | -------- 63 | 64 | Simple example which calls Nagios NRPE scripts (a good source of scripts to 65 | perform various checks, see "`yum search nrpe`" or "`apt-cache search nrpe`" 66 | for a list of available packages). 67 | 68 | statusfile('/var/lib/nanomon.status') 69 | mailto('user@example.com') 70 | mailfrom('nanomon@example.com') 71 | 72 | # this check has a description, otherwise the basename of the 73 | # check command is used ("check_zfs.sh" in this example). 74 | command('/usr/lib/nagios/plugins/check_zfs.sh -p data', 75 | success = re.compile(r'^OK:').match, 76 | description = 'ZFS') 77 | 78 | command('/usr/lib/nagios/plugins/check_mdstat.sh', 79 | success = re.compile(r'^OK:').match) 80 | command('/usr/lib/nagios/plugins/check_disk -c 10% -p /', 81 | success = re.compile(r'^DISK OK ').match) 82 | command('/usr/lib/nagios/plugins/check_disk -c 10% -p /boot', 83 | success = re.compile(r'^DISK OK ').match) 84 | 85 | # uncomment the following line to simulate a failure. 86 | # this takes 15 runs of nanomon before an alert is sent. 87 | #command('/bin/false', success = 0) 88 | 89 | Installation 90 | ------------ 91 | 92 | The following steps will install nanomon: 93 | 94 | - Copy "`nanomon`" to some location on the system, such as `/usr/local/sbin` 95 | - Create a "`/usr/local/etc/nanomon.conf`" file. (This location can be 96 | changed by editing the top of "`nanomon`") 97 | - Add "nanomon" to cron, for example with: `echo '* * * * * root 98 | /usr/local/sbin/nanomon' >/etc/cron.d/nanomon` 99 | 100 | If you would like nanomon to re-alert periodically if a failure persists, 101 | you can set up a cron job to run "`nanomon reset`", which acts like the 102 | service has recovered (without sending an alert). So if it is still down, 103 | this would cause another alert to be sent. However, if the service 104 | recovers within 15 (default) minutes of the reset, no recovery will be 105 | sent. 106 | 107 | Running "`nanomon --help`" will display the help message: 108 | 109 | Usage: nanomon [options] [status|reset|daemon] 110 | 111 | A small service checking program, which can run an series of commands, check 112 | their results, and report when they repeatedly fail, and when they recover. 113 | 114 | Options: 115 | -h, --help show this help message and exit 116 | -c FILE, --config=FILE 117 | Override the configuration file path 118 | -i INTERVAL, --interval=INTERVAL 119 | Daemon mode: How frequently in seconds checks are run 120 | -m INTERVAL, --min-interval=INTERVAL 121 | Daemon mode: Minimum time in seconds between checks 122 | -p FILE, --pidfile=FILE 123 | Daemon mode: File to write process ID into. 124 | 125 | If called with the "reset" command, the status of all services is reset to to 126 | the default state. If called with the "status" command, the state file is 127 | loaded and either "OK" is printed and nanomon exits with 0, or information on 128 | the failed services is printed and nanomon exits with 1. If called with no 129 | command-line commands, a check of all services is run. Typically this is how 130 | it is called from cron. If called with the "daemon" command, nanomon loops 131 | running its own scheduler rather than running from cron. This is useful if 132 | you want to run checks more frequently than every minute. 133 | 134 | License 135 | ------- 136 | 137 | nanomon is licensed under the GPL v3 or later. 138 | -------------------------------------------------------------------------------- /WHATSNEW: -------------------------------------------------------------------------------- 1 | ================================ 2 | Version 1.04 -- Sun Mar 03, 2013 3 | 4 | Removing the "with" reference so it works with older Pythons. 5 | 6 | ================================ 7 | Version 1.03 -- Sat Feb 23, 2013 8 | 9 | Log a message when an alert is generated (down or up). 10 | Added "daemon" mode to run more frequently than every minute. 11 | 12 | ================================ 13 | Version 1.02 -- Tue Feb 19, 2013 14 | 15 | "UP" e-mail now includes what services were previously down. 16 | Suggested by Martin Seener. 17 | 18 | ================================ 19 | Version 1.01 -- Mon Feb 04, 2013 20 | 21 | Adding "alertafterfailures" config setting so you can easily control how 22 | long before alerts are sent. Suggested by Martin Seener. 23 | -------------------------------------------------------------------------------- /nanomon: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # 3 | # Extremely small and light weight monitoring. 4 | # 5 | # Copyright (c) 2011-2015, Sean Reifschneider 6 | # All Rights Reserved 7 | # Licensed under GPL version 3 or later, see "LICENSE" for more information. 8 | 9 | configFile = '/usr/local/etc/nanomon.conf' 10 | 11 | import os 12 | import sys 13 | import pickle 14 | import syslog 15 | syslog.openlog('nanomon', syslog.LOG_PID) 16 | 17 | 18 | ################## 19 | class configClass: 20 | def __init__(self): 21 | self.commands = [] 22 | self.debug = 0 23 | self.statusfile = None 24 | self.mailto = None 25 | self.mailto_set = False 26 | self.mailfrom = None 27 | self.mailfrom_set = False 28 | self.maxfailures = 15 29 | self.mailcmd = '/usr/sbin/sendmail -t -oi' 30 | self.status = None 31 | 32 | def cmd_command(self, command, success, description=None): 33 | self.commands.append((command, success, description)) 34 | 35 | def cmd_alertafterfailures(self, maxfailures): 36 | self.maxfailures = maxfailures 37 | 38 | def cmd_statusfile(self, statusfile): 39 | self.statusfile = statusfile 40 | 41 | def cmd_mailto(self, mailto): 42 | self.mailto = mailto 43 | self.mailto_set = True 44 | 45 | def cmd_mailfrom(self, mailfrom): 46 | self.mailfrom = mailfrom 47 | self.mailfrom_set = True 48 | 49 | def cmd_mailcmd(self, mailcmd): 50 | self.mailcmd = mailcmd 51 | 52 | def cmd_debug(self, level=1): 53 | self.debug = level 54 | 55 | 56 | ############################### 57 | def loadConfigFile(configFile): 58 | # set up config environment 59 | config = configClass() 60 | namespace = { 61 | 'command': config.cmd_command, 62 | 'mailto': config.cmd_mailto, 63 | 'mailfrom': config.cmd_mailfrom, 64 | 'statusfile': config.cmd_statusfile, 65 | 'debug': config.cmd_debug, 66 | 'mailcmd': config.cmd_mailcmd, 67 | 'alertafterfailures': config.cmd_alertafterfailures, 68 | } 69 | 70 | # load the file 71 | import re 72 | try: 73 | execfile(configFile, {'re': re}, namespace) 74 | except Exception: 75 | print ( 76 | 'ERROR: Loading configuration file failed.' 77 | ' See below for details:') 78 | raise 79 | 80 | # return the data 81 | return(config) 82 | 83 | 84 | ################### 85 | class commandClass: 86 | def __init__(self): 87 | self.failures = [] 88 | self.descriptions = [] 89 | self.any_failed = False 90 | 91 | def run(self, command, success, description): 92 | import shlex 93 | import subprocess 94 | 95 | descriptions = self.descriptions 96 | failures = self.failures 97 | 98 | if isinstance(command, str): 99 | args = shlex.split(command) 100 | else: 101 | args = command 102 | 103 | if description is None: 104 | description = os.path.basename(args[0]) 105 | 106 | proc = subprocess.Popen( 107 | args, stdout=subprocess.PIPE, 108 | stderr=subprocess.PIPE, close_fds=True) 109 | output, errors = proc.communicate() 110 | 111 | if isinstance(success, int): 112 | if proc.returncode != success: 113 | descriptions.append(description) 114 | failures.append('Check "%s"' % command) 115 | failures.append( 116 | 'Exit=%s expected %s' 117 | % (proc.returncode, success)) 118 | failures.append(' Output: %s' % output) 119 | failures.append(' Stderr: %s' % errors) 120 | self.any_failed = True 121 | elif callable(success): 122 | ret = success(output) 123 | if not ret: 124 | descriptions.append(description) 125 | failures.append('Check "%s"' % command) 126 | failures.append('Function returned "%s"' % (repr(ret),)) 127 | failures.append(' Output: %s' % format(output)) 128 | failures.append(' Stderr: %s' % format(errors)) 129 | self.any_failed = True 130 | else: 131 | if success not in output: 132 | descriptions.append(description) 133 | failures.append('Check "%s"' % command) 134 | failures.append('String "%s" not found in output' % (success,)) 135 | failures.append(' Output: %s' % format(output)) 136 | failures.append(' Stderr: %s' % format(errors)) 137 | self.any_failed = True 138 | 139 | 140 | ######################## 141 | def runcommands(config): 142 | runner = commandClass() 143 | for command, success, description in config.commands: 144 | runner.run(command, success, description) 145 | 146 | config.any_failed = runner.any_failed 147 | config.failures = runner.failures 148 | config.descriptions = runner.descriptions 149 | 150 | return runner.any_failed 151 | 152 | 153 | ############# 154 | class Status: 155 | def __init__(self, filename): 156 | self.filename = filename 157 | self.load() 158 | 159 | def reset(self): 160 | self.status = { 161 | 'failures': 0, 162 | 'isup': 1, 163 | 'descriptions': None, 164 | } 165 | 166 | def load(self): 167 | self.reset() 168 | 169 | try: 170 | with open(self.filename, 'r') as fp: 171 | filedata = fp.read() 172 | try: 173 | self.status = pickle.loads(filedata) 174 | except: 175 | pass 176 | except IOError: 177 | pass 178 | 179 | def save(self): 180 | with open(self.filename + '.tmp', 'w') as fp: 181 | pickle.dump(self.status, fp) 182 | os.rename(self.filename + '.tmp', self.filename) 183 | 184 | 185 | ############## 186 | def format(s): 187 | if s is None: 188 | return s 189 | return s.rstrip() 190 | 191 | 192 | ################################### 193 | def sendmail(config, isup, status): 194 | import subprocess 195 | import os 196 | 197 | if not config.mailto or not config.mailcmd: 198 | return 199 | 200 | if not config.mailfrom: 201 | config.mailfrom = config.mailto 202 | 203 | hostname = os.uname()[1] 204 | 205 | proc = subprocess.Popen( 206 | config.mailcmd.split(), stdin=subprocess.PIPE, close_fds=True) 207 | proc.stdin.write('From: %s\n' % config.mailfrom) 208 | proc.stdin.write('To: %s\n' % config.mailto) 209 | if isup: 210 | descriptions = status['last_alert_description'] 211 | proc.stdin.write( 212 | 'Subject: UP: Service restored: %s\n\n' % descriptions) 213 | proc.stdin.write('\n') 214 | proc.stdin.write('Services are restored on %s\n' % hostname) 215 | else: 216 | descriptions = status['alert_description'] 217 | proc.stdin.write( 218 | 'Subject: DOWN: Service OUTAGE: %s\n\n' % descriptions) 219 | proc.stdin.write('\n') 220 | proc.stdin.write('Services have issues on %s\n' % hostname) 221 | proc.stdin.write('\n') 222 | for line in config.failures: 223 | proc.stdin.write('%s\n' % line) 224 | proc.stdin.close() 225 | proc.wait() 226 | 227 | 228 | ############################# 229 | def loadconfig(configFile): 230 | '''A wrapper for loading the config file which displays errors.''' 231 | try: 232 | config = loadConfigFile(configFile) 233 | except IOError, e: 234 | if e.errno == 2: 235 | print 'ERROR: Unable to open config file "%s":' % configFile 236 | print ' ', str(e) 237 | syslog.syslog('Invalid config file "%s"' % configFile) 238 | sys.exit(1) 239 | raise 240 | 241 | return config 242 | 243 | 244 | ########### 245 | def main(): 246 | config = loadconfig(configFile) 247 | 248 | if not config.mailto_set: 249 | print 'ERROR: No "mailto" specified in config file' 250 | sys.exit(1) 251 | 252 | if not config.mailfrom_set: 253 | print ( 254 | 'WARNING: No "mailfrom" specified in config file, using ' 255 | '"mailto" value') 256 | 257 | config.status = Status(config.statusfile) 258 | status = config.status.status 259 | runcommands(config) 260 | 261 | if config.any_failed: 262 | status['failures'] += 1 263 | status['descriptions'] = ', '.join(config.descriptions) 264 | else: 265 | status['failures'] = 0 266 | status['descriptions'] = None 267 | alerting = status['failures'] > config.maxfailures 268 | 269 | send_alert = False 270 | if status['isup'] and alerting: 271 | # was up, now is down 272 | status['isup'] = 0 273 | send_alert = True 274 | elif not status['isup'] and not alerting: 275 | # was down, now is up 276 | status['isup'] = 1 277 | send_alert = True 278 | 279 | if send_alert: 280 | status['last_alert_description'] = status.get( 281 | 'alert_description', 'Unknown') 282 | status['alert_description'] = status.get('descriptions', 'Unknown') 283 | 284 | if status['isup']: 285 | syslog.syslog( 286 | 'Alert: UP: %s' % status['last_alert_description']) 287 | else: 288 | syslog.syslog( 289 | 'Alert: DOWN: %s' % status['alert_description']) 290 | 291 | sendmail(config, status['isup'], status) 292 | 293 | config.status.save() 294 | 295 | 296 | #################### 297 | def daemon(options): 298 | import time 299 | import signal 300 | 301 | if options.interval is None: 302 | sys.stderr.write('ERROR: Daemon mode requires "--interval"\n') 303 | sys.exit(1) 304 | 305 | if options.pidfile: 306 | def remove_pidfile(*args): 307 | os.remove(options.pidfile) 308 | sys.exit(0) 309 | fp = open(options.pidfile, 'w') 310 | fp.write('%s\n' % os.getpid()) 311 | fp.close() 312 | signal.signal(signal.SIGINT, remove_pidfile) 313 | signal.signal(signal.SIGTERM, remove_pidfile) 314 | 315 | while True: 316 | time_before_check = time.time() 317 | try: 318 | syslog.syslog('Running check: %s' % time_before_check) 319 | main() 320 | except Exception, e: 321 | syslog.syslog( 322 | 'ERROR: Received exception "%s" during check' % str(e)) 323 | time_after_check = time.time() 324 | 325 | sleep_time = (time_before_check + options.interval) - time_after_check 326 | if sleep_time < 0.1: 327 | if options.min_interval: 328 | time.sleep(options.min_interval) 329 | else: 330 | time.sleep(sleep_time) 331 | 332 | 333 | ################### 334 | def check_status(): 335 | config = loadconfig(configFile) 336 | config.status = Status(config.statusfile) 337 | old_status = config.status.status 338 | if old_status['failures'] < 1: 339 | print 'OK' 340 | sys.exit(0) 341 | 342 | old_status['status'] = 'DOWN' 343 | if old_status['isup']: 344 | old_status['status'] = 'UP' 345 | 346 | print ( 347 | 'ERROR: %(failures)s failures (%(descriptions)s), %(status)s' 348 | % old_status) 349 | sys.exit(1) 350 | 351 | 352 | ############ 353 | def reset(): 354 | config = loadconfig(configFile) 355 | old_status = Status(config.statusfile) 356 | old_status.reset() 357 | old_status.save() 358 | 359 | 360 | ############################ 361 | if __name__ == '__main__': 362 | from optparse import OptionParser 363 | 364 | opt_description = ( 365 | 'A small service checking program, which can run an ' 366 | 'series of commands, check their results, and report when they ' 367 | 'repeatedly fail, and when they recover.') 368 | opt_epilog = ( 369 | 'If called with the "reset" command, the status ' 370 | 'of all services is reset to to the default state. If called ' 371 | 'with the "status" command, the state file is loaded and either ' 372 | '"OK" is printed and nanomon exits with 0, or information on the ' 373 | 'failed services is printed and nanomon exits with 1. If called ' 374 | 'with no command-line commands, a check of all services is run. ' 375 | 'Typically this is how it is called from cron. If called with ' 376 | 'the "daemon" command, nanomon loops running its own scheduler ' 377 | 'rather than running from cron. This is useful if you want to run ' 378 | 'checks more frequently than every minute.') 379 | 380 | parser = OptionParser( 381 | usage='%prog [options] [status|reset|daemon]', 382 | description=opt_description, epilog=opt_epilog) 383 | parser.add_option( 384 | '-c', '--config', dest='config_file', 385 | metavar='FILE', help='Override the configuration file path') 386 | parser.add_option( 387 | '-i', '--interval', dest='interval', 388 | metavar='INTERVAL', default=None, type="int", 389 | help='Daemon mode: How frequently in seconds checks are run') 390 | parser.add_option( 391 | '-m', '--min-interval', dest='min_interval', 392 | metavar='INTERVAL', default=None, type="int", 393 | help='Daemon mode: Minimum time in seconds between checks') 394 | parser.add_option( 395 | '-p', '--pidfile', dest='pidfile', 396 | metavar='FILE', default=None, 397 | help='Daemon mode: File to write process ID into.') 398 | (options, args) = parser.parse_args() 399 | 400 | if not 'daemon' in args and ( 401 | options.interval is not None 402 | or options.min_interval is not None 403 | or options.pidfile is not None): 404 | sys.stderr.write( 405 | 'ERROR: The "--interval", "--min-interval", and "--pidfile" ' 406 | 'options must\n be used with the "daemon" command.\n') 407 | sys.exit(1) 408 | 409 | if options.config_file: 410 | configFile = options.config_file 411 | 412 | if 'status' in args: 413 | check_status() 414 | elif 'reset' in args: 415 | reset() 416 | elif 'daemon' in args: 417 | daemon(options) 418 | else: 419 | main() 420 | -------------------------------------------------------------------------------- /nanomon.conf: -------------------------------------------------------------------------------- 1 | statusfile('/var/lib/nanomon.status') 2 | mailto('user@example.com') 3 | mailfrom('nanomon@example.com') 4 | 5 | # this check has a description, otherwise the basename of the 6 | # check command is used ("check_zfs.sh" in this example). 7 | command('/usr/lib/nagios/plugins/check_zfs.sh -p data', 8 | success = re.compile(r'^OK:').match, 9 | description = 'ZFS') 10 | 11 | command('/usr/lib/nagios/plugins/check_mdstat.sh', 12 | success = re.compile(r'^OK:').match) 13 | command('/usr/lib/nagios/plugins/check_disk -c 10% -p /', 14 | success = re.compile(r'^DISK OK ').match) 15 | command('/usr/lib/nagios/plugins/check_disk -c 10% -p /boot', 16 | success = re.compile(r'^DISK OK ').match) 17 | 18 | # uncomment the following line to simulate a failure. 19 | # this takes 15 runs of nanomon before an alert is sent. 20 | #command('/bin/false', success = 0) 21 | 22 | # Change this if you want to adjust the number of failed checks after 23 | # which an alert will be sent. Each failure represents a minute. 24 | # Beware of setting this too low as it may alert on transient issues 25 | # rather than real outages. 26 | #alertafterfailures(15) 27 | -------------------------------------------------------------------------------- /tests/Makefile: -------------------------------------------------------------------------------- 1 | TESTS = test_*.py 2 | 3 | test: 4 | @- $(foreach TEST,$(TESTS), \ 5 | echo === Running test: $(TEST); \ 6 | python $(TEST) \ 7 | ) 8 | -------------------------------------------------------------------------------- /tests/basic_config: -------------------------------------------------------------------------------- 1 | statusfile('nanomon.status') 2 | #mailcmd(None) 3 | mailcmd('cat') 4 | mailto('root') 5 | mailfrom('root') 6 | command('./test_checker', success = 0) 7 | alertafterfailures(15) 8 | -------------------------------------------------------------------------------- /tests/swapfailure_config: -------------------------------------------------------------------------------- 1 | statusfile('nanomon.status') 2 | #mailcmd(None) 3 | mailcmd('cat') 4 | mailto('root') 5 | mailfrom('root') 6 | command('./test_checker status_1', success = 0) 7 | command('./test_checker status_2', success = 0) 8 | alertafterfailures(5) 9 | -------------------------------------------------------------------------------- /tests/test_basic.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # 3 | # Basic tests of nanomon 4 | # 5 | #=============== 6 | # This is based on a skeleton test file, more information at: 7 | # 8 | # https://github.com/linsomniac/python-unittest-skeleton 9 | 10 | import unittest 11 | import os 12 | import subprocess 13 | 14 | 15 | def check_command(test, command, output=None, exit_code=0): 16 | proc = subprocess.Popen( 17 | command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, 18 | close_fds=True) 19 | stdout, stderr = proc.communicate() 20 | 21 | test.assertEqual('', stderr) 22 | if output: 23 | test.assertIn(output, stdout) 24 | test.assertEqual(proc.returncode, exit_code) 25 | 26 | 27 | class Checker: 28 | def __init__(self, test, config_file): 29 | self.test = test 30 | self.config_file = config_file 31 | 32 | def age_status(self, output=None): 33 | '''Age the status of the system by running checks.''' 34 | check_command(self.test, [ 35 | 'python', self.test.nanomon_path, '--config', self.config_file], 36 | output=output) 37 | 38 | def check_status(self, up=False, ok=False): 39 | output_str = ', UP' if up is True else ', DOWN' 40 | if ok: 41 | output_str = 'OK' 42 | exit_code = 0 if ok is True else 1 43 | check_command(self.test, [ 44 | 'python', self.test.nanomon_path, '--config', 45 | self.config_file, 'status'], output=output_str, 46 | exit_code=exit_code) 47 | 48 | 49 | class test_Basic(unittest.TestCase): 50 | @classmethod 51 | def setUp(self): 52 | if os.path.exists('nanomon'): 53 | self.nanomon_path = './nanomon' 54 | elif os.path.exists('../nanomon'): 55 | self.nanomon_path = '../nanomon' 56 | else: 57 | raise ValueError('Unable to find nanomon executable') 58 | 59 | try: 60 | os.remove('nanomon.status') 61 | except OSError: 62 | pass 63 | 64 | def tearDown(self): 65 | file_list = ['test_checker', 'status_1', 'status_2', 'nanomon.status'] 66 | for filename in file_list: 67 | try: 68 | os.remove(filename) 69 | except OSError: 70 | pass 71 | 72 | def test_Basic(self): 73 | config_file = 'basic_config' 74 | checker = Checker(self, config_file) 75 | 76 | # make checker fail 77 | with open('test_checker', 'w') as fp: 78 | fp.write('#!/bin/bash\n\nfalse\n') 79 | os.chmod('test_checker', 0755) 80 | 81 | check_command( 82 | self, ['python', self.nanomon_path, '--help'], 83 | 'Usage: nanomon') 84 | check_command(self, [ 85 | 'python', self.nanomon_path, '--config', config_file, 86 | '--help'], 'Usage: nanomon') 87 | 88 | check_command(self, [ 89 | 'python', self.nanomon_path, '--config', config_file, 90 | 'reset']) 91 | 92 | for i in xrange(15): 93 | checker.age_status() 94 | checker.check_status(up=True) 95 | 96 | # Check e-mail subject 97 | checker.age_status( 98 | output='Subject: DOWN: Service OUTAGE: test_checker') 99 | checker.check_status(up=False) 100 | 101 | for i in xrange(15): 102 | checker.age_status() 103 | checker.check_status(up=False) 104 | 105 | # make checker succeed 106 | with open('test_checker', 'w') as fp: 107 | fp.write('#!/bin/bash\n\ntrue\n') 108 | os.chmod('test_checker', 0755) 109 | 110 | # Check e-mail subject 111 | checker.age_status( 112 | output='Subject: UP: Service restored: test_checker') 113 | checker.check_status(ok=True) 114 | 115 | def disabled_test_SwapFailure(self): 116 | config_file = 'swapfailure_config' 117 | checker = Checker(self, config_file) 118 | 119 | def set_status(status_1, status_2): 120 | with open('status_1', 'w') as fp: 121 | fp.write('%s' % status_1) 122 | with open('status_2', 'w') as fp: 123 | fp.write('%s' % status_2) 124 | 125 | with open('test_checker', 'w') as fp: 126 | fp.write('#!/bin/bash\n\nexit `cat $1`\n') 127 | os.chmod('test_checker', 0755) 128 | 129 | set_status(0, 0) 130 | 131 | check_command(self, [ 132 | 'python', self.nanomon_path, '--config', config_file, 133 | 'reset']) 134 | 135 | for i in xrange(10): 136 | check_command(self, [ 137 | 'python', self.nanomon_path, '--config', config_file]) 138 | checker.check_status(ok=True) 139 | 140 | set_status(1, 0) 141 | 142 | for i in xrange(5): 143 | checker.age_status() 144 | checker.check_status(up=True) 145 | 146 | # Check e-mail subject 147 | checker.age_status( 148 | output='Subject: DOWN: Service OUTAGE: test_checker') 149 | checker.check_status(up=False) 150 | 151 | set_status(0, 1) 152 | 153 | # should receive an up from the first test 154 | #@@@ This currently is failing due to an enhancement request #4 155 | checker.age_status( 156 | output='Subject: UP: Service restored: test_checker') 157 | checker.check_status(ok=True) 158 | 159 | for i in xrange(5): 160 | checker.age_status() 161 | checker.check_status(up=True) 162 | 163 | # now should fail for the second one 164 | checker.age_status( 165 | output='Subject: DOWN: Service OUTAGE: test_checker') 166 | checker.check_status(up=False) 167 | 168 | for i in xrange(5): 169 | checker.age_status() 170 | checker.check_status(up=False) 171 | 172 | # make checker succeed 173 | set_status(0, 0) 174 | 175 | # Check e-mail subject 176 | checker.age_status( 177 | output='Subject: UP: Service restored: test_checker') 178 | checker.check_status(ok=True) 179 | 180 | 181 | unittest.main() 182 | --------------------------------------------------------------------------------