Merge pull request #54 from guilhemmarchand/version_1037

Version 1.0.37
guilhemmarchand · Dec 22, 2019 · a8a80e3 · a8a80e3
2 parents 77c5236 + c92cc9a
commit a8a80e3
Show file tree

Hide file tree

Showing 69 changed files with 1,985 additions and 554 deletions.
diff --git a/docs/img/ack1.png b/docs/img/ack1.png
diff --git a/docs/img/ack2.png b/docs/img/ack2.png
diff --git a/docs/img/ack3.png b/docs/img/ack3.png
diff --git a/docs/img/ack4.png b/docs/img/ack4.png
diff --git a/docs/img/audit_flipping.png b/docs/img/audit_flipping.png
diff --git a/docs/img/auditing1.png b/docs/img/auditing1.png
diff --git a/docs/img/blacklist_example.png b/docs/img/blacklist_example.png
diff --git a/docs/img/configure_ui.png b/docs/img/configure_ui.png
diff --git a/docs/img/connected_dashboard.png b/docs/img/connected_dashboard.png
diff --git a/docs/img/data_host_drilldown.png b/docs/img/data_host_drilldown.png
diff --git a/docs/img/data_host_main.png b/docs/img/data_host_main.png
diff --git a/docs/img/data_source_drilldown.png b/docs/img/data_source_drilldown.png
diff --git a/docs/img/data_source_main.png b/docs/img/data_source_main.png
diff --git a/docs/img/delete1.png b/docs/img/delete1.png
diff --git a/docs/img/delete2.png b/docs/img/delete2.png
diff --git a/docs/img/drilldown_mainoptions.png b/docs/img/drilldown_mainoptions.png
diff --git a/docs/img/icon_message1.png b/docs/img/icon_message1.png
diff --git a/docs/img/icon_message2.png b/docs/img/icon_message2.png
diff --git a/docs/img/icon_message3.png b/docs/img/icon_message3.png
diff --git a/docs/img/identity_card1.png b/docs/img/identity_card1.png
diff --git a/docs/img/identity_card2.png b/docs/img/identity_card2.png
diff --git a/docs/img/identity_card3.png b/docs/img/identity_card3.png
diff --git a/docs/img/identity_card4.png b/docs/img/identity_card4.png
diff --git a/docs/img/identity_card5.png b/docs/img/identity_card5.png
diff --git a/docs/img/identity_card6.png b/docs/img/identity_card6.png
diff --git a/docs/img/identity_card7.png b/docs/img/identity_card7.png
diff --git a/docs/img/incomplete_installation.png b/docs/img/incomplete_installation.png
diff --git a/docs/img/incomplete_installation_runtracker.png b/docs/img/incomplete_installation_runtracker.png
diff --git a/docs/img/lagging_class_override.png b/docs/img/lagging_class_override.png
diff --git a/docs/img/lagging_class_selection.png b/docs/img/lagging_class_selection.png
diff --git a/docs/img/logical_group1.png b/docs/img/logical_group1.png
diff --git a/docs/img/logical_group2.png b/docs/img/logical_group2.png
diff --git a/docs/img/logical_group3.png b/docs/img/logical_group3.png
diff --git a/docs/img/logical_group4.png b/docs/img/logical_group4.png
diff --git a/docs/img/logical_group5.png b/docs/img/logical_group5.png
diff --git a/docs/img/logical_group6.png b/docs/img/logical_group6.png
diff --git a/docs/img/logical_group7.png b/docs/img/logical_group7.png
diff --git a/docs/img/logical_group8.png b/docs/img/logical_group8.png
diff --git a/docs/img/metric_host_drilldown.png b/docs/img/metric_host_drilldown.png
diff --git a/docs/img/metric_host_main.png b/docs/img/metric_host_main.png
diff --git a/docs/img/modify_lagging.png b/docs/img/modify_lagging.png
diff --git a/docs/img/modify_main.png b/docs/img/modify_main.png
diff --git a/docs/img/modify_priority.png b/docs/img/modify_priority.png
diff --git a/docs/img/monitored_state.png b/docs/img/monitored_state.png
diff --git a/docs/img/monitoring_level.png b/docs/img/monitoring_level.png
diff --git a/docs/img/reset1.png b/docs/img/reset1.png
diff --git a/docs/img/reset2.png b/docs/img/reset2.png
diff --git a/docs/img/run_tracker.png b/docs/img/run_tracker.png
diff --git a/docs/img/screenshot1.png b/docs/img/screenshot1.png
diff --git a/docs/img/screenshot2.png b/docs/img/screenshot2.png
diff --git a/docs/img/screenshot3.png b/docs/img/screenshot3.png
diff --git a/docs/img/screenshot4.png b/docs/img/screenshot4.png
diff --git a/docs/img/week_days1.png b/docs/img/week_days1.png
diff --git a/docs/img/week_days2.png b/docs/img/week_days2.png
diff --git a/docs/img/week_days_table.png b/docs/img/week_days_table.png
diff --git a/docs/img/whitelist_and_blacklist.png b/docs/img/whitelist_and_blacklist.png
diff --git a/docs/img/whitelisting.png b/docs/img/whitelisting.png
diff --git a/docs/releasenotes.rst b/docs/releasenotes.rst
@@ -1,6 +1,14 @@
 Release notes
 #############
 
+Version 1.0.37
+==============
+
+- feature: Introducing the logical group concept which allows grouping data hosts and metric hosts in groups of clusters to manage use cases such as active / passive appliances which passive members do not actively generate data
+- feature: Icon message are now dynamics and provide inline information describing the reason of the status
+- feature: Collection navigation menu to expose quick access to raw KVstore collections content
+- fix: Bad modal cancel action for week days (detailed per day selection) for data host monitoring
+
 Version 1.0.36
 ==============
 

diff --git a/docs/userguide.rst b/docs/userguide.rst
@@ -392,6 +392,118 @@ Deletion of entities
 - When the data source or host is temporary removed, it will be automatically re-created if it has been active during the time range scope of the trackers.
 - When the data source or host is permanently removed, a record of the operation is stored in the audit changes KVstore collection, which we automatically use to prevent the source from being re-created effectively.
 
+Icon dynamic messages
+=====================
+
+**For each type object (data sources / data hosts / metric hosts) the UI shows a status icon which describes the reason for the status with dynamic information:**
+
+.. image:: img/icon_message1.png
+   :alt: icon_message1.png
+   :align: center
+
+.. image:: img/icon_message2.png
+   :alt: icon_message2.png
+   :align: center
+
+.. image:: img/icon_message3.png
+   :alt: icon_message3.png
+   :align: center
+
+To access to the dynamic message, simply focus over the icon in the relevant table cell, and the Web browser will automatically display the message for that entity.
+
+Logical groups (clusters)
+=========================
+
+**Logical groups are groups of entities that will be considered as an ensemble for monitoring purposes.**
+
+A typical use case is a couple of active / passive appliances, where only the active member generates data.
+
+When associated in a Logical group, the entity status relies on the minimal green percentage configured during the group creation versus the current green percentage of the group. (percentages of members green)
+
+*Notes: Logical groups are available to data hosts and metric hosts monitoring objects.*
+
+Create a new logical group
+--------------------------
+
+To create a new logical group and associate a first member, enter the unified modification window (click on a entity and modify button), then click on the "Manage in a Logical group" button:
+
+*For metric hosts:*
+
+.. image:: img/logical_group1.png
+   :alt: logical_group1.png
+   :align: center
+
+*For data hosts:*
+
+.. image:: img/logical_group2.png
+   :alt: logical_group2.png
+   :align: center
+
+If the entity is not yet associated with a logical group (an entity cannot be associated with more than one group), the following message is displayed:
+
+.. image:: img/logical_group3.png
+   :alt: logical_group3.png
+   :align: center
+
+Click on the button "Create a new group" which opens the following configuration window:
+
+.. image:: img/logical_group4.png
+   :alt: logical_group4.png
+   :align: center
+
+- Enter a name for the logical group (names do not need to be uniques and can accept any ascii characters)
+
+- Choose a minimal green percentage for the group, this defines the alerting factor for that group, for example when using 50% (default), a minimal 50% or more of the members need to be green for the logical group status to be green
+
+Associate to an existing logical group
+--------------------------------------
+
+If a logical group already exists and you wish to associate this entity to this group, following the same path (Modify entity) and select the button "Add to an existing group":
+
+.. image:: img/logical_group5.png
+   :alt: logical_group5.png
+   :align: center
+
+- Optionally use the filter input box to search for a logical group
+
+- Click on then logical group entity table, and confirm association to automatically the entity in this logical group
+
+How alerting is handled once the logical group is created with enough members
+-----------------------------------------------------------------------------
+
+Member of logical group is red but logical group is green
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+When an entity is associated to a logical group and if this entity is in red status, but the logical group complies with the monitoring rules, the UI will show a blue icon message which dynamically provides logical group information:
+
+.. image:: img/logical_group6.png
+   :alt: logical_group6.png
+   :align: center
+
+In addition, the entity will not be eligible to trigger any alert as long as the logical group honours the monitoring rules.(minimal green percentage of the logical group)
+
+Member of logical group is red and logical group is red
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+When an entity associated to a logical group is red, and the logical group is red as well (for example in a logical group of 2 nodes where both nodes are down), the UI shows the following:
+
+.. image:: img/logical_group7.png
+   :alt: logical_group7.png
+   :align: center
+
+Alerts will be generated for any entities part of the logical groups which are in red status, and where the monitoring state is enabled.
+
+Remove association from a new logical group
+-------------------------------------------
+
+To remove an association from a logical group, click on the entry table in the initial logical group screen for that entity:
+
+.. image:: img/logical_group8.png
+   :alt: logical_group8.png
+   :align: center
+
+Once the action is confirmed, the association is immediately removed and the entity acts as any other independent entities.
+
 Data identity card
 ==================
 

diff --git a/trackme/default/app.conf b/trackme/default/app.conf
@@ -16,4 +16,4 @@ label = TrackMe
 [launcher]
 author = Guilhem Marchand
 description = Easy data tracking system for Splunk admins
-version = 1.0.36
+version = 1.0.37
diff --git a/trackme/default/collections.conf b/trackme/default/collections.conf
@@ -122,3 +122,13 @@ replicate = false
 
 [kv_trackme_alerts_ack]
 replicate = false
+
+#
+# logical group: a logical group is a group of entities which are considered together when it comes to the status definition
+#
+# Typical use case could be a couple of active / passive firewalls, which passive will not emit certain types of data as long as it remains passive.
+# Members of a same cluster would be another typical use case.
+#
+
+[kv_trackme_logical_group]
+replicate = false