Merge pull request #229 from guilhemmarchand/testing

Version 1.2.31
guilhemmarchand · Feb 2, 2021 · f18d9b3 · f18d9b3
2 parents f1589e7 + 742790f
commit f18d9b3
Show file tree

Hide file tree

Showing 68 changed files with 9,730 additions and 573 deletions.
diff --git a/docs/checklist.rst → docs/archives/checklist.rst.orig b/docs/checklist.rst → docs/archives/checklist.rst.orig
diff --git a/docs/data_sources_unit_tests.csv → docs/archives/data_sources_unit_tests.csv b/docs/data_sources_unit_tests.csv → docs/archives/data_sources_unit_tests.csv
diff --git a/docs/elastic_sources_unit_tests.csv → docs/archives/elastic_sources_unit_tests.csv b/docs/elastic_sources_unit_tests.csv → docs/archives/elastic_sources_unit_tests.csv
diff --git a/docs/lagging_classes_unit_tests.csv → docs/archives/lagging_classes_unit_tests.csv b/docs/lagging_classes_unit_tests.csv → docs/archives/lagging_classes_unit_tests.csv
diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -6,18 +6,21 @@ Configuration
 .. image:: img/configure_ui_metrics_idx.png
    :alt: configure_ui_metrics_idx.png
    :align: center
+   :width: 1200px
 
 .. hint:: Since TrackMe 1.2.4, the application requires the creation of an event index
 
 .. image:: img/configure_ui_summary_idx.png
    :alt: configure_ui_summary_idx.png
    :align: center
+   :width: 1200px
 
 .. tip:: In TrackMe, all main items are macro based such that these can be customised if required, an easy access is provided via the configuration UI
 
 .. image:: img/configure_ui.png
    :alt: configure_ui.png
    :align: center
+   :width: 1200px
 
 Tags enrichment macro definitions
 =================================
@@ -29,6 +32,7 @@ Tags enrichment macro definitions
 .. image:: img/macro_tags.png
    :alt: macro_tags.png
    :align: center
+   :width: 1200px
 
 **Splunk Enterprise Security assets usage:**
 
@@ -113,12 +117,14 @@ TrackMe version 1.0.22 introduced built-in support for both allowlisting of inde
 .. image:: img/allowlist_and_blocklist.png
    :alt: allowlist_and_blocklist.png
    :align: center
+   :width: 800px
 
 The default behaviour of TrackMe is to track data available in all indexes, which changes if allowlisting has been defined:
 
 .. image:: img/allowlisting.png
    :alt: allowlisting.png
    :align: center
+   :width: 800px
 
 The same UI allows you to define blocklisted items, which are added as part of a "NOT" boolean syntax within the searches.
 
@@ -184,3 +190,4 @@ Data hosts global alerting policy
 .. image:: img/data_hosts_allerting_policy_config.png
    :alt: data_hosts_allerting_policy_config.png
    :align: center
+   :width: 1200px
diff --git a/docs/img/first_steps/data_host_reset.png b/docs/img/first_steps/data_host_reset.png
diff --git a/docs/img/first_steps/img022.png b/docs/img/first_steps/img022.png
diff --git a/docs/img/first_steps/img023.png b/docs/img/first_steps/img023.png
diff --git a/docs/img/first_steps/img028.png b/docs/img/first_steps/img028.png
diff --git a/docs/img/first_steps/img_delete_elastic_sources.png b/docs/img/first_steps/img_delete_elastic_sources.png
diff --git a/docs/img/first_steps/img_delete_elastic_sources2.png b/docs/img/first_steps/img_delete_elastic_sources2.png
diff --git a/docs/img/first_steps/metric_host_reset.png b/docs/img/first_steps/metric_host_reset.png
diff --git a/docs/img/identity_card_defined.png b/docs/img/identity_card_defined.png
diff --git a/docs/img/identity_card_global.png b/docs/img/identity_card_global.png
diff --git a/docs/img/identity_card_global2.png b/docs/img/identity_card_global2.png
diff --git a/docs/img/identity_card_notdefined.png b/docs/img/identity_card_notdefined.png
diff --git a/docs/img/img_rest_api_wrapper1.png b/docs/img/img_rest_api_wrapper1.png
diff --git a/docs/img/img_rest_api_wrapper2.png b/docs/img/img_rest_api_wrapper2.png
diff --git a/docs/img/logo.png b/docs/img/logo.png
diff --git a/docs/img/smart_status/access_rest.png b/docs/img/smart_status/access_rest.png
diff --git a/docs/img/smart_status/access_rest2.png b/docs/img/smart_status/access_rest2.png
diff --git a/docs/img/smart_status/access_ui.png b/docs/img/smart_status/access_ui.png
diff --git a/docs/img/smart_status/access_ui2.png b/docs/img/smart_status/access_ui2.png
diff --git a/docs/img/smart_status/access_ui3.png b/docs/img/smart_status/access_ui3.png
diff --git a/docs/img/smart_status/access_ui4.png b/docs/img/smart_status/access_ui4.png
diff --git a/docs/img/smart_status/access_ui5.png b/docs/img/smart_status/access_ui5.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -22,22 +22,27 @@ Welcome to the Splunk TrackMe application documentation
 .. image:: img/screenshots_main/img001.png
    :alt: img001.png
    :align: center
+   :width: 1200px
 
 .. image:: img/screenshots_main/img002.png
    :alt: img002.png
    :align: center
+   :width: 1200px
 
 .. image:: img/screenshots_main/img003.png
    :alt: img003.png
    :align: center
+   :width: 1200px
 
 .. image:: img/screenshots_main/img004.png
    :alt: img004.png
    :align: center
+   :width: 1200px
 
 .. image:: img/screenshots_main/img005.png
    :alt: img005.png
    :align: center
+   :width: 1200px
 
 **Why this application?**
 
@@ -115,4 +120,3 @@ Versioning and build history:
    :caption: Versioning
 
    releasenotes.rst
-   checklist.rst
diff --git a/docs/itsi_integration.rst b/docs/itsi_integration.rst
@@ -34,14 +34,17 @@ Step 1: entity search and creation
 .. image:: img/itsi_entities_start.png
    :alt: itsi_entities_start.png
    :align: center
+   :width: 1200px
 
 .. image:: img/itsi_entities_start2.png
    :alt: itsi_entities_start2.png
    :align: center
+   :width: 1200px
 
 .. image:: img/itsi_entities_start3.png
    :alt: itsi_entities_start3.png
    :align: center
+   :width: 1200px
 
 Note: make sure to edit the permission of the report and shared at the global level
 
@@ -56,6 +59,7 @@ Note: make sure to edit the permission of the report and shared at the global le
 .. image:: img/itsi_entities.png
    :alt: itsi_entities.png
    :align: center
+   :width: 1200px
 
 **Click next and define the entities fields import:**
 
@@ -69,16 +73,19 @@ Note: make sure to edit the permission of the report and shared at the global le
 .. image:: img/itsi_entities2.png
    :alt: itsi_entities2.png
    :align: center
+   :width: 1200px
 
 **Click next to generate the entities, and setup a recurrent import job:**
 
 .. image:: img/itsi_entities3.png
    :alt: itsi_entities3.png
    :align: center
+   :width: 1200px
 
 .. image:: img/itsi_entities4.png
    :alt: itsi_entities4.png
    :align: center
+   :width: 1200px
 
 Any new data source discovered and configured in TrackMe will be created in ITSI, and existing entities will be maintained automatically.
 
@@ -90,6 +97,7 @@ Step 2: create the KPI base search for metrics
 .. image:: img/itsi_kpi1.png
    :alt: itsi_kpi1.png
    :align: center
+   :width: 1200px
 
 **We will create a KPI base search handling the metric index, we use an adhoc search instead of the Metric Search type to allow one KPI base search to handle all of the metrics at once:**
 
@@ -102,16 +110,19 @@ Step 2: create the KPI base search for metrics
 .. image:: img/itsi_kpi2.png
    :alt: itsi_kpi2.png
    :align: center
+   :width: 1200px
 
 *Then add each metric as a new KPI: (see the last screen for the definition of the calculation and service level aggregation)*
 
 .. image:: img/itsi_kpi3.png
    :alt: itsi_kpi3.png
    :align: center
+   :width: 1200px
 
 .. image:: img/itsi_kpi4.png
    :alt: itsi_kpi4.png
    :align: center
+   :width: 1200px
 
 Step 3: create the KPI base searches for summary statuses events
 ----------------------------------------------------------------
@@ -146,14 +157,17 @@ Step 3: create the KPI base searches for summary statuses events
 .. image:: img/itsi_summary_events_kpi_data_source.png
    :alt: iitsi_summary_events_kpi_data_source.png
    :align: center
+   :width: 1200px
 
 .. image:: img/itsi_summary_events_kpi_data_host.png
    :alt: iitsi_summary_events_kpi_data_host.png
    :align: center
+   :width: 1200px
 
 .. image:: img/itsi_summary_events_kpi_metric_host.png
    :alt: iitsi_summary_events_kpi_metric_host.png
    :align: center
+   :width: 1200px
 
 *Notes:*
 
@@ -173,6 +187,7 @@ Step 4: create a service that will be used for the service template definition
 .. image:: img/itsi_service2.png
    :alt: itsi_service2.png
    :align: center
+   :width: 1200px
 
 *Create a KPI manually based on the KPI base searches we created for each of the TrackMe metrics including the event based metric:*
 
@@ -181,10 +196,12 @@ Step 4: create a service that will be used for the service template definition
 .. image:: img/itsi_service3.png
    :alt: itsi_service3.png
    :align: center
+   :width: 1200px
 
 .. image:: img/itsi_service4.png
    :alt: itsi_service4.png
    :align: center
+   :width: 1200px
 
 *Create KPIs and tresholds for summary statuses events:*
 
@@ -193,26 +210,31 @@ Step 4: create a service that will be used for the service template definition
 .. image:: img/itsi_service_kpi_data_source.png
    :alt: itsi_service_kpi_data_source.png
    :align: center
+   :width: 1200px
 
 .. image:: img/itsi_service_kpi_threshold_data_source.png
    :alt: itsi_service_kpi_threshold_data_source.png
    :align: center
+   :width: 1200px
 
 *data hosts tracking*
 
 .. image:: img/itsi_service_kpi_data_host.png
    :alt: itsi_service_kpi_data_host.png
    :align: center
+   :width: 1200px
 
 .. image:: img/itsi_service_kpi_threshold_data_host.png
    :alt: itsi_service_kpi_threshold_data_host.png
    :align: center
+   :width: 1200px
 
 *metric hosts tracking*
 
 .. image:: img/itsi_service_kpi_metric_host.png
    :alt: itsi_service_kpi_metric_host.png
    :align: center
+   :width: 1200px
 
 *repeat the same threshold configuration*
 
@@ -221,6 +243,7 @@ Step 4: create a service that will be used for the service template definition
 .. image:: img/itsi_service6.png
    :alt: itsi_service6.png
    :align: center
+   :width: 1200px
 
 *Note: This pseudo service can optionally be deleted post service template creation, but you can as well keep it to allow future service creation based on this service rather using the service template feature.*
 
@@ -236,6 +259,7 @@ Step 5: create a service template
 .. image:: img/itsi_service_template.png
    :alt: itsi_service_template.png
    :align: center
+   :width: 1200px
 
 Final: Create services business and technical services using TrackMe KPIs
 -------------------------------------------------------------------------
@@ -247,29 +271,36 @@ Finally, the ITSI integration is ready and you can create new services using the
 .. image:: img/itsi_example1.png
    :alt: itsi_example1.png
    :align: center
+   :width: 1200px
 
 .. image:: img/itsi_example2.png
    :alt: itsi_example2.png
    :align: center
+   :width: 1200px
 
 .. image:: img/itsi_customer_example1.png
    :alt: itsi_customer_example1.png
    :align: center
+   :width: 1200px
 
 .. image:: img/itsi_customer_example2.png
    :alt: itsi_customer_example2.png
    :align: center
+   :width: 1200px
 
 .. image:: img/itsi_customer_example3.png
    :alt: itsi_customer_example3.png
    :align: center
+   :width: 1200px
 
 .. image:: img/itsi_customer_example4.png
    :alt: itsi_customer_example4.png
    :align: center
+   :width: 1200px
 
 .. image:: img/itsi_customer_example5.png
    :alt: itsi_customer_example5.png
    :align: center
+   :width: 1200px
 
 **TrackMe acts now transparently as a companion of ITSI, you will continue to manage data sources in TrackMe, create Elastic sources, manage states and max lagging values which are reflected naturally in ITSI.**
diff --git a/docs/releasenotes.rst b/docs/releasenotes.rst
@@ -1,6 +1,36 @@
 Release notes
 #############
 
+Version 1.2.31
+==============
+
+**CAUTION:**
+
+This is a new main release branch, TrackMe 1.2.x requires the deployment of the following dependencies:
+
+- Semicircle Donut Chart Viz, Splunk Base: https://splunkbase.splunk.com/app/4378
+- Splunk Machine Learning Toolkit, Splunk Base: https://splunkbase.splunk.com/app/2890
+- Splunk Timeline - Custom Visualization, Splunk Base: https://splunkbase.splunk.com/app/3120
+
+TrackMe requires a summary index (defaults to trackme_summary) and a metric index (defaults to trackme_metrics):
+https://trackme.readthedocs.io/en/latest/configuration.html
+
+- Feature: Introducing the trackme REST API wrapper SPL command, allows interracting with the TrackMe REST API endpoints within SPL queries!
+- Feature: Introducing the smart status REST API endpoints, performs advanced status correlations and investigations easily and automatically, within the UI, as part of an alert action or within your third party automation!
+- Feature: REST API endpoint for Data Sampling - allow reset and run sampling
+- Feature: UI - Issue #223 - multiselect form enhancement with auto disablement of the ALL choice when selecting at least one entry in the multiselect
+- Feature: Identity cards - Issue #226 - allow defining a global default identity card associated with all data sources (per data source identity cards can still be created and take precedence over the global card)
+- Feature: Elastic Sources - Issue #227 - allow deletion of both dedicated and shared sources in the UI via the new REST framework, deletion automatically performs the deletion of related objects (KVstore contents, report, etc)
+- Fix - Issue #217 - Activity alerts view results link would result to 404 page not found for out of the box alerts
+- Fix - Issue #218 - Data sampling - creating custom rule from the main screen, then clicking on back button leads to wrong window
+- Fix - Issue #219 - Outliers detection - dropdown for alert on upper is not pre-filled with the actual setting of the entity
+- Fix - Issue #220 - Audit scheduling - in some environments, status="success" is replaced at search time by status="completed" (internal scheduler) which is not expected by the searches
+- Fix - Issue #221 - Data sources - Tags are not preserved following actions in the UI
+- Fix - Issue #224 - Outliers - Switching an entity between different periods may lead the outliers generation to be failing
+- Fix - Issue #225 - Outliers - Data hosts outliers configuration update within the UI causes an entity refresh which does not generate flipping statuses events as expected
+- Fix - Issue #228 - REST API - Endpoints should honour the user context while logging the action in the audit log collection
+- Change: Icons change
+
 Version 1.2.30
 ==============