diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/02-Configuration.md | 53 | ||||
| -rw-r--r-- | doc/03-CustomVars.md | 50 | ||||
| -rw-r--r-- | doc/09-Security.md | 26 | ||||
| -rw-r--r-- | doc/10-Screenshots.md | 24 | ||||
| -rw-r--r-- | doc/screenshots/configuration-backend.png | bin | 0 -> 14171 bytes | |||
| -rw-r--r-- | doc/screenshots/configuration-monitoring.png | bin | 0 -> 20968 bytes | |||
| -rw-r--r-- | doc/screenshots/monitoring-actions.png | bin | 0 -> 26487 bytes | |||
| -rw-r--r-- | doc/screenshots/monitoring-detailview.png | bin | 0 -> 70118 bytes | |||
| -rw-r--r-- | doc/screenshots/overview-filtered.png | bin | 0 -> 122651 bytes | |||
| -rw-r--r-- | doc/screenshots/overview-with-details.png | bin | 0 -> 166770 bytes | |||
| -rw-r--r-- | doc/screenshots/overview.png | bin | 0 -> 149458 bytes |
11 files changed, 153 insertions, 0 deletions
diff --git a/doc/02-Configuration.md b/doc/02-Configuration.md new file mode 100644 index 0000000..0f6b04e --- /dev/null +++ b/doc/02-Configuration.md @@ -0,0 +1,53 @@ +Configuration +============= + +## Database Resource + +To let the module know where the events are stored you have to create an SQL +database resource, with the EventDB schema, and events collected by EventDB. + +Access to the EventDB for the module is handled with normal Icingaweb2 resources. + +Create the resource and go to the config area to select it: + + Configuration -> Modules -> Eventdb -> Backend + + + +## Monitoring Integration + +The EventDB module integrates into Icinga Web 2's monitoring module by default, +offering action links in host and service detail views. + + + +### Default actions + +By default, every host and services shows an action link to the event list, +filtered by host name. + +### Custom Variable + +You can configure a custom variable that enables the integration selectively. + +* `_edb` or `vars.edb` will enable the actions only on objects that have the custom var +* `_edb_filter` or `vars.edb_filter` allows you to pre-filter the linked events + +The name of the customvar (`edb`) needs to be configured in the config area of the module. + +Also see [Custom Variables](03-CustomVars.md) documentation. + +### Always show actions + +There are options to always show actions on host or service, even if the custom variable +is not set. + +### Detail view + +Icingaweb adds a new feature in 2.5.0 to allow extra content inside the detail views +of hosts and services. + +By default the view filters for not acknowledged events, and shows you the last, most +critical events first. One can jump to events list or a detail view immediately. + +Custom filters can be added in the config area, also the view can be disabled there.
\ No newline at end of file diff --git a/doc/03-CustomVars.md b/doc/03-CustomVars.md new file mode 100644 index 0000000..cfd4b74 --- /dev/null +++ b/doc/03-CustomVars.md @@ -0,0 +1,50 @@ +Custom Variables +================ + +The monitoring integration of this module can use custom variables from the +Icinga context to control display and filtering of the integration. + +Also see [Configuration](02-Configuration.md) on how to configure the features. + +Custom variables control: + +* If the EventDB integration and actions are shown for a host or service +* How the linked results should be filtered + +## Examples + +For Icinga 2: + +```icinga2 +object Host "test" { + import "generic-host" + + address = "127.0.0.1" + + vars.edb = "1" + vars.edb_filter = "priority!=7&priority!=5&priority!=6&ack=0" + // ... +} +``` + +For Icinga 1.x: + +```nagios +define host { + use generic-host + host_name test + + address 127.0.0.1 + + _edb 1 + _edb_filter priority!=7&priority!=5&priority!=6&ack=0 +} +``` + +**Note:** A filter by `host_name` will always be added, unless you have `host_name` as part of your filter. + +## Legacy filters + +The module also supports legacy JSON filters from the icinga-web 1.x EventDB module. + +Please see the `examples` directory of this module for some supported filters. diff --git a/doc/09-Security.md b/doc/09-Security.md new file mode 100644 index 0000000..9aab433 --- /dev/null +++ b/doc/09-Security.md @@ -0,0 +1,26 @@ +Security +============================ + +The EventDB Module provides permissions and restrictions as described below. + +## Permissions + +| Name | Description | +| ---------------- | ----------- | +| eventdb/events | Allow to view events | +| eventdb/comments | Allow to view comments | +| eventdb/interact | Allow to acknowledge and comment events | + +## Restrictions + +| Name | Description | +| ----------------------- | ----------- | +| eventdb/events/filter | Restrict views to the events that match the filter | +| eventdb/comments/filter | Restrict views to the comments that match the filter | + +## Examples + +| eventdb/events/filter | Description | +| -------------------------- | ----------- | +| type!=syslog | Hide the Syslog events from a role | +| type=syslog&program=icinga | Show only Icinga-related Syslog events to a role | diff --git a/doc/10-Screenshots.md b/doc/10-Screenshots.md new file mode 100644 index 0000000..22905d3 --- /dev/null +++ b/doc/10-Screenshots.md @@ -0,0 +1,24 @@ +Screenshots +=========== + +**Overview of Events** + + + +**Filtered overview** + + + +**Detail area** + + + +**Monitoring actions** + + + +**Monitoring detail view** + +For Icinga Web 2 >= 2.5.0 + +
\ No newline at end of file diff --git a/doc/screenshots/configuration-backend.png b/doc/screenshots/configuration-backend.png Binary files differnew file mode 100644 index 0000000..6de9fba --- /dev/null +++ b/doc/screenshots/configuration-backend.png diff --git a/doc/screenshots/configuration-monitoring.png b/doc/screenshots/configuration-monitoring.png Binary files differnew file mode 100644 index 0000000..d6c9e8d --- /dev/null +++ b/doc/screenshots/configuration-monitoring.png diff --git a/doc/screenshots/monitoring-actions.png b/doc/screenshots/monitoring-actions.png Binary files differnew file mode 100644 index 0000000..724e0a0 --- /dev/null +++ b/doc/screenshots/monitoring-actions.png diff --git a/doc/screenshots/monitoring-detailview.png b/doc/screenshots/monitoring-detailview.png Binary files differnew file mode 100644 index 0000000..e7ceb83 --- /dev/null +++ b/doc/screenshots/monitoring-detailview.png diff --git a/doc/screenshots/overview-filtered.png b/doc/screenshots/overview-filtered.png Binary files differnew file mode 100644 index 0000000..d183cd8 --- /dev/null +++ b/doc/screenshots/overview-filtered.png diff --git a/doc/screenshots/overview-with-details.png b/doc/screenshots/overview-with-details.png Binary files differnew file mode 100644 index 0000000..53a6008 --- /dev/null +++ b/doc/screenshots/overview-with-details.png diff --git a/doc/screenshots/overview.png b/doc/screenshots/overview.png Binary files differnew file mode 100644 index 0000000..99cc82d --- /dev/null +++ b/doc/screenshots/overview.png |
