Skip to content
This repository has been archived by the owner on Feb 3, 2023. It is now read-only.

Commit

Permalink
Merge pull request #112 from guilhemmarchand/version_1218
Browse files Browse the repository at this point in the history
Version 1.2.18
  • Loading branch information
guilhemmarchand committed Jul 13, 2020
2 parents a5b2eec + 76982f5 commit 46f3529
Show file tree
Hide file tree
Showing 20 changed files with 2,947 additions and 1,898 deletions.
16 changes: 8 additions & 8 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,22 +87,22 @@ The builtin views "Ops: Indexes queues" and "Ops: Parsing issues" rely on the us

Customise the macro definition to match your indexers host naming convention.

Whitelisting and blacklisting
Allowlisting and blocklisting
=============================

TrackMe version 1.0.22 introduced builtin support for both whitelisting of indexes and blacklisting of indexes, sourcetypes and hosts.
TrackMe version 1.0.22 introduced builtin support for both allowlisting of indexes and blocklisting of indexes, sourcetypes and hosts.

.. image:: img/whitelist_and_blacklist.png
:alt: whitelist_and_blacklist.png
.. image:: img/allowlist_and_blocklist.png
:alt: allowlist_and_blocklist.png
:align: center

The default behaviour of TrackMe is to track data available in all indexes, which changes if whitelisting has been defined:
The default behaviour of TrackMe is to track data available in all indexes, which changes if allowlisting has been defined:

.. image:: img/whitelisting.png
:alt: .png
.. image:: img/allowlisting.png
:alt: allowlisting.png
:align: center

The same UI allows you to define blacklisted items, which are added as part of a "NOT" boolean syntax within the searches.
The same UI allows you to define blocklisted items, which are added as part of a "NOT" boolean syntax within the searches.

Finally, in addition the following macro is used within the searches, and can be customized if you need:

Expand Down
Binary file added docs/img/allowlist_and_blocklist.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/allowlisting.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/img/blacklist_btns.png
Binary file not shown.
Binary file removed docs/img/blacklist_example.png
Binary file not shown.
Binary file added docs/img/blocklist_example.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/img/whitelist_and_blacklist.png
Binary file not shown.
Binary file removed docs/img/whitelisting.png
Binary file not shown.
19 changes: 19 additions & 0 deletions docs/releasenotes.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,25 @@
Release notes
#############

Version 1.2.18
==============

**CAUTION:**

This is a new main release branch, TrackMe 1.2.x require 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

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

- Fix: Builtin alerts should do not honour index allowlisting (for entities created before allowlists were configured)
- Change: In support with the elimination of long term used negative words in IT, whitelist and blacklist concepts are replaced with allowlist and blocklist concepts
- Fix/Feature: UI improvement with a checkbox in table approach to provide deletion capabilities on the different screens such as allowlist and blocklist, in some circumstances the drilldown approach was causing trouble with unexpected closure of the modal window
- Fix: Outliers generation with mstats and the append=true mode fails in some distributed architecture, the single schedule report is replaced with a scheduled per potential period configured for entities, in a high performing fashion and capable of dealing with any number of entities
- Fix: Active links such as opening in a search a data source might get broken in some environments when using a custom Splunk URI path (root_endpoint in web.conf)

Version 1.2.17
==============

Expand Down
28 changes: 12 additions & 16 deletions docs/userguide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -483,41 +483,37 @@ When a lagging class is defined and is matched for a data source or a data host,

Finally, when a custom lagging value is defined for an object, a value of "true" is created for the field named "data_override_lagging_class", which value is used to determine the actual value for that object.

Whitelisting & Blacklisting features
Allowlisting & Blocklisting features
====================================

**TrackMe version 1.0.22 introduced builtin support for both whitelisting of indexes and blacklisting of indexes, sourcetypes and hosts.**
**TrackMe version 1.0.22 introduced builtin support for both allowlisting of indexes and blocklisting of indexes, sourcetypes and hosts.**

.. image:: img/whitelist_and_blacklist.png
:alt: whitelist_and_blacklist.png
.. image:: img/allowlist_and_blocklist.png
:alt: allowlist_and_blocklist.png
:align: center

**The default behaviour of TrackMe is to track data available in all indexes, which changes if whitelisting has been defined:**
**The default behaviour of TrackMe is to track data available in all indexes, which changes if allowlisting has been defined:**

.. image:: img/whitelisting.png
.. image:: img/allowlisting.png
:alt: .png
:align: center

**Different level of blacklisting features are provided out of the box, which features can be used to avoid taking in consideration indexes, sourcetypes and hosts.**
Different level of blocklisting features are provided out of the box, which features can be used to avoid taking in consideration indexes, sourcetypes and hosts.

.. image:: img/blacklist_btns.png
:alt: blacklist_btns.png
:align: center

*The following type of blacklisting entries are supported:**
*The following type of blocklisting entries are supported:**

- explicit names, example: ``dev001``
- wildcards, example: ``dev-*``
- regular expressions, example: ``(?i)dev-.*``

*regular expressions are supported starting version 1.1.6.*

*metric_category blacklisting for metric hosts supports explicit blacklist only.*
*metric_category blocklisting for metric hosts supports explicit blacklist only.*

**Adding or removing a blacklist item if performed entirely and easily within the UI:**
**Adding or removing a blocklist item if performed entirely and easily within the UI:**

.. image:: img/blacklist_example.png
:alt: blacklist_example.png
.. image:: img/blocklist_example.png
:alt: blocklist_example.png
:align: center

Manual run of the trackers
Expand Down
11 changes: 2 additions & 9 deletions trackme/app.manifest
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"id": {
"group": null,
"name": "trackme",
"version": "1.2.17"
"version": "1.2.18"
},
"author": [
{
Expand Down Expand Up @@ -40,14 +40,7 @@
"uri": "https://trackme.readthedocs.io/en/latest/releasenotes.html"
}
},
"dependencies": {
"Splunk_ML_Toolkit": {
"version": ">=4.5.0"
},
"semicircle_donut": {
"version": ">=1.0.1"
}
},
"dependencies": null,
"tasks": null,
"inputGroups": null,
"incompatibleApps": null,
Expand Down
24 changes: 24 additions & 0 deletions trackme/appserver/static/checkbox_table.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/* The standalone checkbox square*/
.checkbox {
width:20px;
height:20px;
border: 1px solid #000;
display: inline-block;
}

/* This is what simulates a checkmark icon */
.checkbox.checked:after {
content: '';
display: block;
width: 4px;
height: 7px;

/* "Center" the checkmark */
position:relative;
top:4px;
left:7px;

border: solid #000;
border-width: 0 2px 2px 0;
transform: rotate(45deg);
}

0 comments on commit 46f3529

Please sign in to comment.