.. trackme documentation master file, created by
   sphinx-quickstart on Tue Sep 18 23:25:46 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to TrackMe - Data in motion tracking system
===================================================

**TrackMe for Splunk is the ideal companion for your Splunk deployment, no matters the size of your environment, its unique capabilities help you on a daily basis to get the best value from your Splunk investments:**

- Discover and maintain Splunk entities at scale, track availability and quality of any kind of data in Splunk
- Virtual tenancy is a key concept in TrackMe which allows creating on the fly knowledge objects in a repeatable way: create and scope tenants, experiment, destroy and restart as needed
- TrackMe allows tracking your local Splunk deployment, or transparently any number of Splunk remote deployments (subject to licensing restrictions)
- TrackMe's unique workflow combines best Splunk capabilities, from a comprehensive user interface to notable events generation, SLA tracking and many more
- Get the best from TrackMe components, using splk-feeds components provide deep Splunk feed tracking, splk-cim provides Common Information Model (CIM) compliance tracking, splk-flx (FLEX) adapts to any kind of Splunk magic query! (components are subjects to license restrictions) 
- Extend the visibility at any point in time with Hybrid and Elastic trackers, use Machine Learning outliers detection with deep and easy control, TrackMe is incredibly rich in features

.. image:: img_v2/welcome/screen1.png
   :alt: screen1.png
   :align: center
   :width: 1200px
   :class: with-border

.. image:: img_v2/welcome/screen2.png
   :alt: screen2.png
   :align: center
   :width: 1200px
   :class: with-border

.. image:: img_v2/welcome/screen3.png
   :alt: screen3.png
   :align: center
   :width: 1200px
   :class: with-border

.. image:: img_v2/welcome/screen4.png
   :alt: screen4.png
   :align: center
   :width: 1200px
   :class: with-border

License & support:
==================

.. toctree::
   :maxdepth: 2
   :caption: License, terms & conditions, support

   license
   terms_and_conditions
   support

Compatibility and download:
===========================

.. toctree::
   :maxdepth: 2
   :caption: Compatibility & Download

   compatibility
   download

Requirements:
=============

.. toctree::
   :maxdepth: 2
   :caption: Requirements

   requirements

Installation:
=============

.. toctree::
   :maxdepth: 2
   :caption: Installation

   installation
   upgrade
   migration_trackmev1
   license_registration

Administration guide:
=====================

.. toctree::
   :maxdepth: 2
   :caption: Administration guide

   admin_guide_configuration
   admin_guide_theme
   admin_guide_high_env_scaling
   admin_guide_vtenants_create
   admin_guide_vtenants_manage
   admin_guide_vtenants_ops
   admin_guide_vtenant_scheduling
   admin_guide_vtenants_user_profile
   admin_guide_remote_deployments
   admin_guide_rbac
   admin_guide_alerts
   admin_guide_mloutliers
   admin_guide_trackme_sourcetypes
   admin_guide_rest
   admin_guide_hybrid_trackers
   admin_guide_wlk_trackers
   admin_guide_flex_trackers
   admin_guide_cim_trackers
   admin_guide_feeds_tags
   admin_guide_dsm_docs_notes
   admin_guide_expected_hosts
   admin_guide_cmdb_integration
   admin_guide_elastic
   admin_guide_cicd
   admin_guide_maintenance
   admin_guide_trackme_app_on_soar

White papers:
=============

.. toctree::
   :maxdepth: 2
   :caption: White papers

   white_papers
   white_paper_trackme_poc
   white_paper_events_drop_detection
   white_paper_workload
   white_paper_monitor_indexer_cluster
   white_paper_monitor_shc
   white_paper_trackme_backup_and_restore
   white_paper_sla_alerting
   
User guide:
===========

.. toctree::
   :maxdepth: 2
   :caption: User guide

   user_guide_priority
   user_guide_monitored_state
   user_guide_status_message
   user_guide_flipping_status
   user_guide_notable_events
   user_guide_ack
   user_guide_splk_feeds_kpis
   user_guide_splk_feeds_thresholds
   user_guide_splk_feeds_delayed_entities
   user_guide_splk_logical_groups
   user_guide_splk_wlk
   user_guide_soar_monitoring
   user_guide_cribl_monitoring

Troubleshoot & FAQ:
===================

.. toctree::
   :maxdepth: 1
   :caption: Troubleshoot

   troubleshoot.rst
   faq.rst

Versioning and build history:
=============================

.. toctree::
   :maxdepth: 1
   :caption: Versioning

   releasenotes.rst

Various
=======

.. toctree::
   :maxdepth: 1
   :caption: Various

   third_party_credits.rst