Splunk® IT Service Intelligence

Modules

Download manual as PDF

Download topic as PDF

Database Module configurations

Configure the ITSI Database Module to connect your database instance data to your Splunk platform deployment

Module entity roles

See the below table to identify the roles that the Database Module assigns to entities:

ITSI Module ITSI Role
ITSI Database Module database_instance

Step 1: Install supported technologies

The Database Module uses either the Splunk DB Connect 2 or 3 add-on to collect data for the Splunk Add-on for Microsoft SQL Server and the Splunk Add-on for Oracle Database.

The ITSI Database Module requires installation of the Splunk Add-on for Unix and Linux, or the Splunk Add-on for Microsoft Windows to collect host-level metrics, such as Host, CPU, and Memory.

See About installing Splunk add-ons to learn how to install a Splunk add-on in the following deployment scenarios.

Install your ITSI supported technologies onto your deployment using the reference table below. For single-instance deployments, install all supported technologies on your single instance.

Technology Name Installation Link Search Heads Universal Forwarders (Install on each host that has a database server installed) Heavy Forwarder (Install on a host dedicated to running only DB Connect)
Splunk DB Connect Installation guide X
Splunk Add-on for Microsoft SQL Server Installation guide X X
Splunk Add-on for Oracle Database Installation guide X
Splunk Add-on for Microsoft Windows Installation guide X X
Splunk Add-on for Unix and Linux Installation guide X X

Step 2: Configure supported technologies to collect data and send to your Splunk deployment

The ITSI Database Module uses the Splunk Add-on for Microsoft Windows and the Splunk Add-on for Unix and Linux to display OS host level metrics including CPU, Memory, Storage, and Network in the drilldown visualizations.

Once installed, the Windows and Unix add-ons can be used with the ITSI Operating System Module for additional KPIs and visualizations.

DB instance details 2.3.png

See the Operating System Module configurations section of the ITSI Operating System Module manual to install and configure your operating system host data.

Step 3: Configure the Splunk add-on for DB Connect to collect data and send to your Splunk deployment

Use DB Connect version 2 or 3 to connect to and poll databases to retrieve performance and inventory data for populating the ITSI Database Module.

  1. Ensure that DB Connect is installed on a Heavy Forwarder that can be dedicated specifically to running DB Connect.
  2. Create a new database identity to connect to your database.
  3. Create a new database connection through the DB Connect UI, or in databases.conf
  4. Copy the contents of the template files in the below add-ons, and paste to the $SPLUNK_HOME/etc/apps/splunk_app_db_connect/local/db_inputs.conf file of DB Connect.
  5. Configure the local/db_inputs.conf file in DB Connect using the below table for reference.
Add-on Template file location Configuration inputs for DB Connect
Splunk Add-on for Microsoft SQL Server $SPLUNK_HOME/etc/apps/Splunk_TA_microsoft-

sqlserver/default/sqlserver_dbx2.conf

  • Change "disabled=1" to "disabled=0"
  • Change "connection=SQLServer" to the connection name created in step 3 above. Ensure the connect name matches the connection name in database.conf
Splunk Add-on for Oracle Database $SPLUNK_HOME/etc/apps/Splunk_TA_oracle/

default/dbx2.inputs.conf.template

  • Change "disabled=1" to "disabled=0"
  • Change "connection=Oracle_Connection" to the connection name created in step 3 above. Ensure the connect name matches the connection name in database.conf

For more information on DB Connect, see the Install DB Connect installation and setup checklist. For information on installing the DB Connect in a distributed deployment, see the Distributed Deployment section of the Splunk DB Connect manual.

Step 4: Configure lookups

Configure lookup file for Microsoft SQL Server

Data collection through the Splunk Add-on for Microsoft SQL Server requires the configuration of a lookup file to correlate the database server, database instances, and host data. To retrieve the database server name, run SELECT CONVERT(varchar(128),SERVERPROPERTY('ServerName')) AS database_instance; in your SQL server management studio.

In $SPLUNK_HOME/etc/apps/Splunk_TA_microsoft-sqlserver/lookups/sqlserver_host_dbserver_lookup.csv on the indexers, enter your database information in the database_instance, host, and port fields:

database_instance host port
Example: TAG-EX-W12R2-100 tag-ex-w12r2-100 1433

Step 5: Enable entity discovery

Enable entity discovery for the module to automatically discover entities for which relevant data has been collected. See Enable the automatic entity discovery search.

Last modified on 30 April, 2020
PREVIOUS
About the Database Module
  NEXT
Database Module KPIs and thresholds

This documentation applies to the following versions of Splunk® IT Service Intelligence: 4.0.0, 4.0.1, 4.0.2, 4.0.3, 4.0.4, 4.1.0, 4.1.1, 4.1.2, 4.1.5, 4.2.0, 4.2.1, 4.2.2, 4.2.3, 4.3.0, 4.3.1, 4.4.0, 4.4.1, 4.4.2, 4.4.3, 4.4.4, 4.5.0 Cloud only


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