From 4c0c02bc2886d4ec8af5c91718b0a9ba23ceb9a2 Mon Sep 17 00:00:00 2001 From: Marius Hein Date: Fri, 6 Feb 2015 14:24:09 +0100 Subject: [PATCH] Layout of README file --- .gitignore | 1 + README.md | 40 +++++++++++++++++++++++++++++++--------- doc/{IDEAS => IDEAS.md} | 3 ++- 3 files changed, 34 insertions(+), 10 deletions(-) create mode 100644 .gitignore rename doc/{IDEAS => IDEAS.md} (94%) diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9f11b75 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.idea/ diff --git a/README.md b/README.md index 10a2b7f..1451620 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,53 @@ # Business Processes - Icinga Web 2 module -If you want to visualize and monitor hierarchical business processes based on any or all objects monitored by Icinga, the Icinga Web 2 business process module is the way to go. +If you want to visualize and monitor hierarchical business processes based on +any or all objects monitored by Icinga, the Icinga Web 2 business process +module is the way to go. -Want to create custom process-based dashboards? Trigger notifications at process or sub-process level? Provide a quick top-level view for thousands of components on a single screen? That's what this module has been designed for! +Want to create custom process-based dashboards? Trigger notifications at +process or sub-process level? Provide a quick top-level view for thousands of +components on a single screen? That's what this module has been designed for! -You're running a huge cloud, want to get rid of the monitoring noise triggered by your auto-scaling platform but still want to have detailled information just a couple of clicks away in case you need them? You will love this littled addon! +You're running a huge cloud, want to get rid of the monitoring noise triggered +by your auto-scaling platform but still want to have detailed information just +a couple of clicks away in case you need them? You will love this little addon! # Installation -Like with any other Icinga Web 2 module just drop me to one of your module folders and enable the `businessprocess` module in your web frontend or on CLI. Of course the `monitoring` module needs to be enabled and that's it, we have no farther dependencies. +Like with any other Icinga Web 2 module just drop me to one of your module +folders and enable the `businessprocess` module in your web frontend or on CLI. + +Of course the `monitoring` module needs to be enabled and that's it, we have no +further dependencies. # History -The Business Process module is based on the ideas of the Nagios(tm) Business Process Addon written by Bernd Strößenreuther and available at http://bp-addon.monitoringexchange.org/. We always loved it's simplicity and while it looks pretty oldschool right now there are still many shops happily using it in production. +The Business Process module is based on the ideas of the +Nagios(tm) Business Process Addon written by Bernd Strößenreuther and available +at http://bp-addon.monitoringexchange.org/. We always loved it's simplicity +and while it looks pretty oldschool right now there are still many shops +happily using it in production. ## Compatibiliy -We fully support the BPaddon config language and will continue to do so. It's also perfectly valid to run both products in parallel based on the very same config files. +We fully support the BPaddon config language and will continue to do so. It's +also perfectly valid to run both products in parallel based on the very same +config files. -However, lot's of changes went on and are still going on under the hood. We have more features and new language constructs. We separated the config reader from the state fetcher in our code base. This will allow us to optionally support config backends like SQL databases. They are not faster than plain old text files, but they make it much easier to distribute configuration in a large environment. +However, lot's of changes went on and are still going on under the hood. We +have more features and new language constructs. We separated the config reader +from the state fetcher in our code base. This will allow us to optionally +support config backends like SQL databases. They are not faster than plain old +text files, but they make it much easier to distribute configuration in a large +environment. ## Improvements ### Speed -This module is definitively faster than the BPaddon used to be. No need for IDO caching or similar. +This module is definitively faster than the BPaddon used to be. No need for IDO +caching or similar. +## Todos TODO: business impact of a specific object - diff --git a/doc/IDEAS b/doc/IDEAS.md similarity index 94% rename from doc/IDEAS rename to doc/IDEAS.md index b07e837..e6bc2f6 100644 --- a/doc/IDEAS +++ b/doc/IDEAS.md @@ -1,3 +1,4 @@ +# Collection of ideas Filter "appserver" = host=*-rz-app-* & service=*jmx* @@ -5,6 +6,6 @@ Filter "appserver kunde1" = Filter["appserver"] & _host_customer = kunde1 Process "kunde1" = 1 of: Filter["appserver kunde1"]->group('hostname') - Customer App * => host_name = customer-app-* => service_description = lx-jmx-* | service_description = lx-procs tomcat + Customer App = 1 of: Audi App *