diff options
| -rw-r--r-- | .gitignore | 2 | ||||
| -rw-r--r-- | LICENSE | 340 | ||||
| -rw-r--r-- | README.md | 15 | ||||
| -rw-r--r-- | application/controllers/ConfigController.php | 66 | ||||
| -rw-r--r-- | application/controllers/IndexController.php | 269 | ||||
| -rw-r--r-- | application/forms/Config/SettingConfigForm.php | 137 | ||||
| -rw-r--r-- | application/views/scripts/config/index.phtml | 11 | ||||
| -rw-r--r-- | application/views/scripts/index/index.phtml | 84 | ||||
| -rw-r--r-- | configuration.php | 13 | ||||
| -rw-r--r-- | demo.png | bin | 0 -> 49753 bytes | |||
| -rw-r--r-- | library/BoxyDash/Grid.php | 27 | ||||
| -rw-r--r-- | module.info | 4 | ||||
| -rw-r--r-- | public/css/module.less | 66 |
13 files changed, 1034 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..19f1e51 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +*.swp +sinker.sh @@ -0,0 +1,340 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/> + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + {description} + Copyright (C) {year} {fullname} + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + {signature of Ty Coon}, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..9223856 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# icingaweb2-module-boxydash +An "at a view" dashboard showing the overall view of your icinga implementation + + + + + + +# Installation +Simply check this out to /usr/share/icingaweb2/modules/boxydash then symlink to it from /etc/icingaweb2/enabledModules/boxydash + +it should now appear in + icingacli modules list + +as well as your web interface. diff --git a/application/controllers/ConfigController.php b/application/controllers/ConfigController.php new file mode 100644 index 0000000..3974497 --- /dev/null +++ b/application/controllers/ConfigController.php @@ -0,0 +1,66 @@ +<?php + +use Icinga\Web\Notification; +use Icinga\Data\ResourceFactory; +use Icinga\Forms\ConfirmRemovalForm; +use Icinga\Web\Controller; +use Icinga\Module\Monitoring\Forms\Config\BackendConfigForm; +use Icinga\Module\Monitoring\Forms\Config\InstanceConfigForm; +use Icinga\Module\Monitoring\Forms\Config\SecurityConfigForm; +use Icinga\Module\Boxydash\Forms\Config\SettingConfigForm; + +class BoxyDash_ConfigController extends Controller +{ + public function indexAction() + { + $this->view->settingsConfig = $this->Config('settings'); + + $form = new SettingConfigForm(); + $this->view->form = $form; + $form->setTitle($this->translate('Edit Existing Instance')); + $form->setIniConfig($this->Config('config')); + $form->setRedirectUrl('boxydash'); + $form->handleRequest(); + + $this->view->form = $form; + + $this->getTabs()->activate('config'); + } + + public function editSettingsAction() + { + $form = new SettingConfigForm(); + + $form->setTitle($this->translate('Edit Settings')); + $form->setIniConfig($this->Config('settings')); + $form->setRedirectUrl('boxydash'); + $form->handleRequest(); + + + $this->view->form = $form; + } + + + + public function getTabs() + { + $tabs = parent::getTabs(); + $tabs->add( + 'dashboard', + array( + 'title' => 'Dashboard', + 'url' => 'boxydash' + ) + ); + $tabs->add( + 'config', + array( + 'title' => 'Configure', + 'url' => 'boxydash/config' + ) + ); + + return $tabs; + } +} + diff --git a/application/controllers/IndexController.php b/application/controllers/IndexController.php new file mode 100644 index 0000000..59a8f8e --- /dev/null +++ b/application/controllers/IndexController.php @@ -0,0 +1,269 @@ +<?php +/* +TODO Things that need to be added: + +- Option to show only hard or soft states +- The ability to configure box size, or set it to dynamically fill the screen + +- Add a filter and custom label so two dashboards could provide different labeled views. +(you may have two boxy dashboards with two different filters open- one for each dev team/environment/project) + +*/ + + +use Icinga\Data\Filter\Filter; +use Icinga\Module\Monitoring\Controller; +use Icinga\Module\Monitoring\Object\Host; +use Icinga\Module\Monitoring\Object\Service; +use Icinga\Web\Url; +use Icinga\Application\Logger; + +#FIXME should this be Controller or ModuleActionController? The documentation was unclear. +class BoxyDash_IndexController extends Controller +{ + protected $default_requiresAuthentication = true; + protected $default_include_softstate = false; + protected $default_boxsize = 20; + protected $default_refresh = 10; + protected $default_showlegend = true; + protected $default_path_prefix = ''; + + public function indexAction() + { + $this->getTabs()->activate('dashboard'); + $this->config = $this->Config('config'); + + $this->determine_refresh(); + $this->determine_showlegend(); + $this->determine_boxsize(); + $this->determine_path_prefix(); + $this->determine_include_softstate(); + + + $isrequired = $this->config->get( 'settings', 'requires_authentication', $this->default_requiresAuthentication ); + + $this->_request->getParams(); + + $this->getServiceData(); + $this->getHostData(); + } + + protected function requiresLogin() + { + #Logger::error("running requiresLogin"); + $this->requiresAuthentication = (bool) $this->Config()->get( + 'settings', + 'requires_authentication', + $this->default_requiresAuthentication + ); + + return parent::requiresLogin(); + } + + public function determine_showlegend() + { + if ($this->_hasParam("showlegend")){ + $this->view->showlegend = (boolean) $this->_getParam("showlegend"); + #Failing that, check to see if it's already in the configuration or use the default legend + }else{ + $this->view->showlegend = (boolean) $this->config->get('settings','show_legend',$this->default_showlegend); + } + } + + public function determine_refresh() + { + if (intval($this->_getParam("refresh")) >=1){ + $this->refresh = intval($this->_getParam("refresh")); + + #Failing that, check to see if it's already in the configuration + }elseif (is_numeric( $this->config->get('settings','setting_refresh','missing'))) { + # Note that $default_refresh should never be hit on this line. + $this->refresh = intval($this->config->get('settings','setting_refresh',$this->default_refresh)); + }else{ + #failing THAT, use our default. + $this->refresh = $this->default_refresh ; + } + $this->setAutorefreshInterval( $this->refresh ); + } + + public function determine_boxsize() + { + if (is_numeric($this->_getParam("boxsize"))){ + $this->view->boxsize = intval($this->_getParam("boxsize")); + + #Failing that, check to see if it's already in the configuration + }elseif (is_numeric( $this->config->get('settings','setting_boxsize','missing'))) { + # Note that $default_boxsize should never be hit on this line. + $this->view->boxsize = $this->config->get('settings','setting_boxsize',$this->default_boxsize); + }else{ + #failing THAT, use our default. + $this->view->boxsize = $this->default_boxsize; + } + } + public function determine_include_softstate() + { + + # First determine if uri override is being passed + if ( $this->_hasParam("include_softstate")){ + $this->view->include_softstate = (boolean) $this->_getParam("include_softstate"); + }else{ + #Failing that, check to see if it's already in the configuration or use the default + $this->view->include_softstate = $this->config->get('settings','include_softstate',$this->default_include_softstate); +# $this->view->debug=intval($this->view->include_softstate); + } + +# $this->view->debug= intval( (bool)$this->view->include_softstate); + } + + public function determine_path_prefix() + { + $this->view->path_prefix = $this->config->get('settings', 'path_prefix', $this->default_path_prefix); + } + + + # Create the tabs for the dashboard and the configuration tab. + public function getTabs() + { + $tabs = parent::getTabs(); + $tabs->add( + 'dashboard', + array( + 'title' => $this->translate('Dashboard'), + 'url' => 'boxydash', + 'tip' => $this->translate('Overview') + ) + ); + if($this->Auth()->isAuthenticated()){ + $tabs->add( + 'config', + array( + 'title' => $this->translate('Configure'), + 'url' => 'boxydash/config', + 'tip' => $this->translate('Configure') + ) + ); + } + + return $tabs; + } + + + # get the status of each host + public function getHostData() + { + $columns = array( + 'host_name', + 'host_display_name', + 'host_state', + 'host_acknowledged', + 'host_in_downtime', + 'host_output', + # Most of these may not be needed; included it for future integration/use (yeah, right) + 'host_icon_image', + 'host_handled', + 'host_attempt', + 'host_state_type', + 'host_hard_state', + 'host_last_check', + 'host_notifications_enabled', + 'host_action_url', + 'host_notes_url', + 'host_active_checks_enabled', + 'host_passive_checks_enabled', + 'host_current_check_attempt', + 'host_max_check_attempts' + + ); + $query = $this->backend->select()->from('hostStatus', $columns); + $this->applyRestriction('monitoring/filter/objects', $query); // follow filter object restrictions + $query->order('host_name', 'desc'); + + # This might be very very bad for very very large environments. I just don't know how well it'll perform. + $this->view->hosts = $query->getQuery()->fetchAll(); + + foreach ($this->view->hosts as $host) { + #FIXME: using Service function for a host state. that's kinda ugly + + # If we allow statetypes, or it's ack'd OR the state type is already HARD + if ( $this->view->include_softstate or $host->{'host_acknowledged'} ){ + $host->{'host_state_text'}=Service::getStateText($host->{'host_state'}); + }else{ + $host->{'host_state_text'}=Service::getStateText($host->{'host_hard_state'}); + } + + } + + } + # get the status of each service + public function getServiceData() + { + $columns = array( + 'host_name', + 'host_display_name', + 'host_in_downtime', + 'host_acknowledged', + 'host_state', + 'host_hard_state', + 'service_hard_state', + 'service_description', + 'service_display_name', + 'service_state', + 'service_in_downtime', + 'service_acknowledged', + 'service_output', + # Most of these may not be needed; included it for future integration/use (yeah, right) + 'host_last_state_change', + 'service_attempt', + 'service_last_state_change', + 'service_is_flapping', + 'service_state_type', + 'service_last_check', + 'current_check_attempt' => 'service_current_check_attempt', + 'max_check_attempts' => 'service_max_check_attempts' + ); + $query = $this->backend->select()->from('serviceStatus', $columns); + $this->applyRestriction('monitoring/filter/objects', $query); // follow filter object restrictions + $query->order('host_name', 'desc'); + + $this->view->services = $query->getQuery()->fetchAll(); + + foreach ($this->view->services as $service) { + #Loop through and make sure there's a field that says "OK" so we can grab the right css class + $service->{'service_state_text'}=Service::getStateText($service->{'service_state'}); + $service->{'host_state_text'}=Service::getStateText($service->{'host_state'}); + + # If we allow statetypes, or it's ack'd OR the state type is already HARD + if ( $this->view->include_softstate or $service->{'service_acknowledged'} ){ + $service->{'service_state_text'}=Service::getStateText($service->{'service_state'}); + }else{ + $service->{'service_state_text'}=Service::getStateText($service->{'service_hard_state'}); + } + + + } + } + +/* This function may be useful if I can figure out an overall way to show it that integrates well. + public function statusSummary(){ + $this->view->stats = $this->backend->select()->from('statusSummary', array( + 'services_total', + 'services_ok', + 'services_problem', + 'services_problem_handled', + 'services_problem_unhandled', + 'services_critical', + 'services_critical_unhandled', + 'services_critical_handled', + 'services_warning', + 'services_warning_unhandled', + 'services_warning_handled', + 'services_unknown', + 'services_unknown_unhandled', + 'services_unknown_handled', + 'services_pending', + ))->getQuery()->fetchRow(); + + } +*/ +} + diff --git a/application/forms/Config/SettingConfigForm.php b/application/forms/Config/SettingConfigForm.php new file mode 100644 index 0000000..3e26b04 --- /dev/null +++ b/application/forms/Config/SettingConfigForm.php @@ -0,0 +1,137 @@ +<?php +/* Icinga Web 2 | (c) 2013-2015 Icinga Development Team | GPLv2+ */ + +namespace Icinga\Module\Boxydash\Forms\Config; + +use Exception; +use Icinga\Data\ConfigObject; +use Icinga\Data\ResourceFactory; +use Icinga\Web\Form; +use InvalidArgumentException; +use Icinga\Application\Config; +use Icinga\Exception\ConfigurationError; +use Icinga\Forms\ConfigForm; +use Icinga\Web\Notification; + +/** + * Form class for creating/modifying monitoring Settings + */ +class SettingConfigForm extends ConfigForm +{ + protected $resources; + + public function init() + { + $this->setName('form_config_boxydash_settings'); + $this->setSubmitLabel($this->translate('Save Changes')); + } + + public function createElements(array $formData) + { + $this->addElement( + 'text', + 'setting_refresh', + array( + 'label' => $this->translate('Dashboard Refresh'), + 'description' => $this->translate('How quickly the dashboard should refresh (between 1 second and 20 minutes)'), + 'value' => '10', + 'validators' => array( + array( + 'Between', + false, + array( + 'min' => '1', + 'max' => '1200', + 'inclusive' => true, + ) + ) + ) + ) + ); + $this->addElement( + 'text', + 'setting_boxsize', + array( + 'label' => $this->translate('Box Size'), + 'description' => $this->translate('The size of displayed boxes in pixels'), + 'value' => '10', + 'validators' => array( + array( + 'Regex', + false, + array( + 'pattern' => '/^[\d]+$/', + 'messages' => array( + 'regexNotMatch' => $this->translate( + 'The application prefix must be a positive integer.' + ) + ) + ) + ) + ) + ) + ); + $this->addElement( + 'checkbox', + 'include_softstate', + array( + 'required' => true, + 'value' => true, + 'label' => $this->translate('Include Soft Status'), + 'description' => $this->translate('Enable this to have soft status included') + ) + ); + $this->addElement( + 'checkbox', + 'requires_authentication', + array( + 'required' => true, + 'value' => true, + 'label' => $this->translate('Require Authentication?'), + 'description' => $this->translate('Does Boxydash require Authentication? Warning, this may expose sensitive network information.') + ) + ); + $this->addElement( + 'checkbox', + 'show_legend', + array( + 'required' => true, + 'value' => true, + 'label' => $this->translate('Show the Legend'), + 'description' => $this->translate('Do you want to show the legend?') + ) + ); + $this->addElement( + 'text', + 'path_prefix', + array( + 'label' => $this->translate('URL path prefix'), + 'description' => $this->translate('Prefix prepended to all links, eg "/icingaweb2". Required in case Icinga Web 2 is installed in a subfolder (eg "http://your-domain.tld/icingaweb2").'), + 'value' => '', + ) + ); + + } + + public function onSuccess() + { + $this->config->setSection('settings', $this->getValues()); + + if ($this->save()) { + Notification::success($this->translate('New setings have successfully been stored')); + } else { + return false; + } + } + + /** + * @see Form::onRequest() + */ + public function onRequest() + { + $this->populate($this->config->getSection('settings')->toArray()); + } + + + +} diff --git a/application/views/scripts/config/index.phtml b/application/views/scripts/config/index.phtml new file mode 100644 index 0000000..053bf8d --- /dev/null +++ b/application/views/scripts/config/index.phtml @@ -0,0 +1,11 @@ + +<?php if (! $this->compact): ?> +<div class="controls"> + <?= $tabs; ?> +</div> +<?php endif ?> +<div class="content"> + <h1>Boxy Dashboard Configuration</h1> + <?=$this->form; ?> +</div> + diff --git a/application/views/scripts/index/index.phtml b/application/views/scripts/index/index.phtml new file mode 100644 index 0000000..6ae2282 --- /dev/null +++ b/application/views/scripts/index/index.phtml @@ -0,0 +1,84 @@ +<? +use Icinga\Module\Monitoring\Object\Service; +use Icinga\Module\Monitoring\Object\Host; + + +?> + +<div class="controls"> + <?php if (! $this->compact): ?> + <?= $tabs; ?> + <?php endif ?> +</div> + + +<div class="content"> + + <h1>Boxy Dashboard</h1> + <? if ($this->showlegend){ ?> + <div class="boxy_legend"> + <span class="boxy_sublegend"> + <span class="legendtext">✔ = Acknowledged</span> + <span class="legendtext">⌚ = In Downtime</span> + <span class="legendtext">↸ = Host Issue Acknowledged</span> + </span> + <span class="boxy_sublegend"> + <span class="legendtext">Status:</span> + <span class="boxy_legend_box ok" >ok</span> + <span class="boxy_legend_box warning" >warning</span> + <span class="boxy_legend_box critical" >critical</span> + <span class="boxy_legend_box unknown" >unknown</span> + </span> + <span class="boxy_sublegend"> + <span class="legendtext" >Acknowledged:</span> + <span class="boxy_legend_box warning-ack" >warning</span> + <span class="boxy_legend_box critical-ack" >critical</span> + <span class="boxy_legend_box unknown-ack" >unknown</span> + </span> + </div> + <? } ?> +<h2>Host Info</h2> +<? +foreach ($this->hosts as $host){ + $title = htmlspecialchars($host->{'host_display_name'}); + $size=$this->boxsize; + $content=" "; + $returncode=$host->{'host_state_text'}; + if ($host->{'host_acknowledged'}==1 ){ + $returncode.="-ack"; + $content= "✔"; + $title.=" (Acknowledged)"; + }?> + <a href='<?= $this->path_prefix ?>/monitoring/host/show?host=<?=$host->{'host_name'}?>' class='boxy_box state <?=$returncode?>' style='width:<?=$size?>px; height:<?=$size?>px; font-size:<?=$size?>px;' title="<?=$title?>"><?=$content?></a> +<? } ?> + +<br clear="all"/> +<h2>Service Info</h2> + +<? foreach ($this->services as $service){ + $service->{'service_hard_state'} = ($service->{'service_hard_state'}) ? "hard" : "soft"; + $title = $service->{'host_display_name'}.": ".$service->{'service_description'}; + #."(".$service->{'current_check_attempt'} .",".$service->{'max_check_attempts'} .")(". $service->{'service_hard_state'}.")+acked:".$service->{'service_acknowledged'} ; + $size=$this->boxsize; + $content=" "; + $returncode=$service->{'service_state_text'}; + if ($service->{'service_in_downtime'}==1 or $service->{'host_in_downtime'}==1 ){ + $returncode.="-downtime"; + $content= "⌚"; + $title.=" (Scheduled Maintenance)"; + }elseif ($service->{'service_acknowledged'}==1 ){ + $returncode.="-ack"; + $content= "✔"; + $title.=" (Acknowledged)"; + }elseif ($service->{'service_state_text'} != "ok" && $service->{'host_acknowledged'} == 1 ){ + $returncode.="-ack"; + $content= "↸"; + $title.=" (Host Issue Acknowledged)"; + } + $title=htmlspecialchars($title."\n ".$service->{'service_output'});?> + <a href='<?= $this->path_prefix ?>/monitoring/service/show?host=<?=$service->{'host_name'}?>&service=<?=$service->{'service_description'}?>' class='boxy_box state <?=$returncode?>' style='width:<?=$size?>px; height:<?=$size?>px; font-size:<?=$size?>px;' title="<?=$title?>"><?=$content?></a> + +<? } ?> +<br clear=all> +<pre style="font-size:20px"><?=$this->debug?></pre> +</div> diff --git a/configuration.php b/configuration.php new file mode 100644 index 0000000..b097d26 --- /dev/null +++ b/configuration.php @@ -0,0 +1,13 @@ +<?php + +$this->providePermission( + 'boxydash', + $this->translate('View Boxy Dashboard') +); + +$this->menuSection('Boxy Dashboard', array( + 'url' => 'boxydash', + 'icon' => 'dashboard', + 'priority' => 20 +)); + diff --git a/demo.png b/demo.png Binary files differnew file mode 100644 index 0000000..f3ba98e --- /dev/null +++ b/demo.png diff --git a/library/BoxyDash/Grid.php b/library/BoxyDash/Grid.php new file mode 100644 index 0000000..cec3940 --- /dev/null +++ b/library/BoxyDash/Grid.php @@ -0,0 +1,27 @@ +<?php + +namespace Icinga\Module\BoxyDash; + +use Icinga\Application\Config; +use Icinga\Exception\ConfigurationError; +use Icinga\Module\Monitoring\Object\MonitoredObject; +use Icinga\Module\Monitoring\Object\Host; +use Icinga\Module\Monitoring\Object\Service; +use Icinga\Web\Hook\GrapherHook; +use Icinga\Web\Url; + +class Grid extends WebBaseHook +{ + protected $hasPreviews = true; + + + + protected $baseUrl = '/boxydash'; + + protected function init() + { + $cfg = Config::module('boxydash')->getSection('boxydash'); + $this->baseUrl = rtrim($cfg->get('base_url', $this->baseUrl), '/'); + } + + diff --git a/module.info b/module.info new file mode 100644 index 0000000..7787b5a --- /dev/null +++ b/module.info @@ -0,0 +1,4 @@ +Module: boxydash +Version: 0.0.1 +Description: Boxy Dashboard module + This is intended to give you another view of the status of your board. diff --git a/public/css/module.less b/public/css/module.less new file mode 100644 index 0000000..d334576 --- /dev/null +++ b/public/css/module.less @@ -0,0 +1,66 @@ +.boxy_legend { +/* Used */ + border: 0px solid blue; + float:right; + font-size:12px; + margin:2px 2px 0px 0px; + text-align:right; + display:block; + text-decoration:none; + vertical-align:middle; +} +.boxy_sublegend { +/* Used */ + border: 0px solid green; + margin-left:20px; + display:inline-block; + vertical-align:middle; + +} +.legendtext { +/* Used */ + width:140px; + height:20px; + font-size:12px; + margin:2px 2px 0px 0px; + display:inline; + text-decoration:none; +} + +.boxy_legend_box { +/* Used */ + padding:4px 4px 4px 4px; + border: 0px solid red; + + text-align:center; + display:inline-block; + text-decoration:none; +} + + +.boxy_box { + margin:2px 2px 0px 0px; + border-right: 1px solid gray; + border-bottom: 1px solid gray; + text-align:center; + display:block; + float:left; + vertical-align:middle; + text-decoration:none; +} + +/* Note: @colors won't work when the board is viewed anonymously */ +.ok {background-color:#44BB77;} +.ok-ack {background-color:#44BB77;} +.warning {background-color:#FFAA44;} +.warning-ack {background-color:#FFCC66;} +.warning-downtime {background-color:#dddddd;} +.critical {background-color:#FF5566} +.critical-ack {background-color:#FF99AA} +.critical-downtime {background-color:#dddddd;} +.unknown {background-color:#AA44FF} +.unknown-ack {background-color:#CC77FF;} +.unknown-downtime {background-color:#dddddd;} + + + |
