Splunk® IT Service Intelligence

Install and Upgrade Splunk IT Service Intelligence

Download manual as PDF

This documentation does not apply to the most recent version of ITSI. Click here for the latest version.
Download topic as PDF

Install Splunk IT Service Intelligence on a single instance

Install Splunk IT Service Intelligence on an on-premises search head. In a single-instance deployment, a single Splunk Enterprise instance serves as both search head and indexer. Splunk Cloud customers must work with Splunk Support to coordinate access to the IT Service Intelligence search head.

You must install ITSI by extracting the ITSI installation package. ITSI does not support installation using the app manager in Splunk Web or using the splunk install app command at the command line.

For information about what and where to install in various types of distributed environments, see Where to install IT Service Intelligence in a distributed environment.

Installation prerequisites

  • Review the Splunk platform requirements for IT Service Intelligence. See Splunk Enterprise system requirements.
  • Your Splunk ITSI instance must include the default admin user. Deleting or renaming this user breaks ITSI installation and operation.

Steps

  1. Log in to splunk.com with your Splunk.com ID.
  2. Download the latest Splunk IT Service Intelligence product from Splunkbase.
  3. Stop your Splunk platform deployment. For example:
    cd $SPLUNK_HOME/bin
    ./splunk stop
    
  4. Extract the ITSI installation package into $SPLUNK_HOME/etc/apps. For example:
    tar -xvf splunk-it-service-intelligence_<latest_version>.spl -C $SPLUNK_HOME/etc/apps
    

    On Windows, rename the file extension from .spl to .tgz first and use a third-party utility to perform the extraction.

  5. Start your Splunk platform deployment. For example:
    cd $SPLUNK_HOME/bin
    ./splunk start
    

Install required Java components

ITSI versions 4.3.x and 4.4.x do not support 32-bit JRE/JDK. Using 32-bit causes the Rules Engine to fail with unclear errors in the search.log. Always use 64-bit JRE/JDK.

IT Service Intelligence requires Java 8.x - 11.x to run anomaly detection and notable event management features. You can install Java prior to or after installing ITSI.

Install Java on all search heads running ITSI. On RHEL and Ubuntu Linux, you can install the vendor packages java-1.8.0-openjdk on RHEL Linux and openjdk-8-jdk on Ubuntu Linux. Alternatively, you can download and install the latest version of Oracle Java 8-11 (JRE or JDK).

If the JAVA_HOME environment variable is set correctly to the base of the Java installation, or the java executable (or java.exe in Windows) can be found using the PATH environment variable, no additional action is required. This is typically the case if you install the vendor Java packages in Linux or OS X.

If you install Java to a custom location, for example, when you install Oracle Java directly from Oracle's website, and neither PATH nor JAVA_HOME is set to the Java installation, you must add the bin bath of the JDK in $HOME/.bashrc. Perform the following steps:

  1. Change to your home directory.
    cd $HOME
    
  2. Open the .bashrc file.
  3. Add the following line to the file. Replace the JDK directory with the name of your java installation directory.
    export PATH=/usr/java/<JDK Directory>/bin:$PATH
    
  4. Save the file and exit.
  5. Use the source command to force Linux to reload the .bashrc file which normally is read only when you log in each time.
    source .bashrc
    

If you want to set the PATH for all users, you need to log in as root in the bash shell and perform the above steps on the .profile file in the etc directory and not the .bashrc file in the home directory.

(Optional) Install required Predictive Analytics add-ons

If you plan to use the ITSI Predictive Analytics capabilities, install the Splunk Machine Learning Toolkit (MLTK) and the Python for Scientific computing add-on. These add-ons are only required if you plan to use Predictive Analytics to predict service health scores. For more information, see Set up Predictive Analytics in ITSI.

  1. Install the Python for Scientific Computing add-on version 1.3 or later for your operating system from Splunkbase:
  2. Install the latest version of the Splunk MLTK. Follow the steps in Install the Splunk Machine Learning Toolkit in the MLTK User Guide.
  3. Give the MLTK app Global permissions:
    1. In ITSI, click App: IT Service Intelligence > Manage Apps.
    2. In the filter bar, enter Splunk Machine Learning Toolkit.
    3. Click Permissions.
    4. Ensure that All apps is selected.
    5. Click Save.

About the ITSI installation package

The ITSI installation package places the following directories in $SPLUNK_HOME/etc/apps:

  • DA-ITSI-APPSERVER
  • DA-ITSI-DATABASE
  • DA-ITSI-EUEM
  • DA-ITSI-LB
  • DA-ITSI-OS
  • DA-ITSI-STORAGE
  • DA-ITSI-VIRTUALIZATION
  • DA-ITSI-WEBSERVER
  • itsi
  • SA-IndexCreation
  • SA-ITOA
  • SA-ITSI-ATAD
  • SA-ITSI-CustomModuleViz
  • SA-ITSI-Licensechecker
  • SA-ITSI-MetricAD
  • SA-UserAccess
  • splunk_app_infrastructure
  • Splunk_TA_Infrastructure

To use CIM-based data models with ITSI, you must manually install Splunk_SA_CIM.

PREVIOUS
Plan your ITSI deployment
  NEXT
Where to install IT Service Intelligence in a distributed environment

This documentation applies to the following versions of Splunk® IT Service Intelligence: 4.2.0, 4.2.1, 4.2.2, 4.2.3, 4.3.0, 4.3.1


Was this documentation topic helpful?

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters