Install the Splunk App for Infrastructure in a distributed deployment
To complete this task, you must be an administrator familiar with clustered environments on Splunk Enterprise.
You can deploy the Splunk App for Infrastructure in your distributed deployment of Splunk Enterprise. To do so, you need to complete these steps:
- Install SAI on the search head tier.
- Install the Splunk Add-on for Infrastructure on the indexer tier.
- Enable the HTTP Event Collector (HEC) on the indexer tier.
- If you want to collect AWS data, deploy or configure a heavy forwarder to handle AWS data collection.
If you want to integrate VMware vCenter Servers in SAI, you have to install additional Splunk add-ons, and configure a Data Collection Scheduler (DCS) and Data Collection Node (DCN). For more information, see Install VMware data collection add-ons and dependencies.
After you complete these steps, start collecting data from systems to monitor in the app. You can run the easy install script, or set up data collection manually. For more information, see the Administer Splunk App for Infrastructure guide.
What the distributed deployment looks like
This diagram describes a distributed environment that is ingesting data from a Windows system, a Mac system, a Linux system, a heavy forwarder for AWS data collection, and a DCN and DCS for VMware data collection. Each system sends S2S traffic from a universal forwarder directly to an indexer cluster and HTTP traffic from collectd to a third-party load balancer. The load balancer forwards traffic to HECs in the indexer cluster.
Where to install the App and other dependencies
The following table describes the required locations for installing the Splunk App for Infrastructure and other dependencies in your distributed deployment environment.
If you want to collect VMware data, there are some additional components you have to install. For information about where to install VMware data collection components, see Where to install VMware data collection components. For information about installing the VMware data collection components, see Install VMware data collection add-ons and dependencies.
|Component||Search heads||Indexers||Heavy forwarder||Description|
|Splunk App for Infrastructure||Required||Required*||*Only when you deploy a heavy forwarder for AWS data collection.|
|Splunk Add-on for Infrastructure||Required||Required*||
You must install the add-on on each indexer to provide props and transforms for data types.
*Only when you deploy a heavy forwarder for AWS data collection or use a heavy forwarder as an intermediary before you send data to an indexer.
|Splunk Add-on for Amazon Web Services||Required||You must install the add-on if you are collecting data from AWS. Version 5.0.0 is supported.|
|HTTP Event Collector||Required*||*If you are collecting metrics from a *nix host, this is required. Collectd, which collects metrics data from *nix hosts, sends data to a HEC.|
|TCP input||Required*||*If you are collecting *nix and Windows logs and Windows metrics, configure a TCP input. You need to configure a port to receive data from a universal forwarder.|
Follow these steps to set up the Splunk App for Infrastructure in a distributed Splunk Enterprise deployment.
1. Install the Splunk App for Infrastructure on search heads
Install the Splunk App for Infrastructure on every search head in the cluster. For more details about this task, see Deploy a configuration bundle in the Splunk Enterprise Distributed Search manual.
First, check that you satisfy the system requirements for the Splunk App for Infrastructure. For more, see System requirements for Splunk App for Infrastructure.
- Download the Splunk App for Infrastructure from Splunkbase.
- On the machine that runs the search head cluster's deployer, copy the
Splunk_App_Infrastructuredirectory to the
- Push the Splunk App for Infrastructure to every search head in the cluster:
$SPLUNK_HOME/bin/splunk apply shcluster-bundle -target <any_cluster_member_mgmt_url:mgmt_port> -auth <username:passwd>
2. Install the Splunk Add-on for Infrastructure on indexers
Install the Splunk Add-on for Infrastructure on the indexers. When you install the add-on, it creates the
infra_alerts indexes, and handles props and transforms for all data types. For more information about the source types and components that the add-on configures, see Source types and components for the Splunk Add-on for Infrastructure in the Use Splunk Add-on for Infrastructure manual.
For more information about installing the add-on across an indexer cluster, see Update common peer configurations and apps in the Managing Indexers and Clusters of Indexers guide.
- Download the Splunk Add-on for Infrastructure from Splunkbase.
- On the machine that runs the indexer cluster master node, copy the
Splunk_TA_Infrastructuredirectory to the
- Validate the bundle and check whether a restart is necessary:
splunk validate cluster-bundle --check-restart
- Apply the bundle to the indexer cluster:
splunk apply cluster-bundle
- To see how the cluster bundle push is going, run this command:
splunk show cluster-bundle-status
3. Configure inputs.conf for the indexing tier
Enable receiving on the TCP port for logs and perform metrics for Windows data collection for every indexer in the cluster. To do this, open a receiving port for the indexing tier. For more information about opening a receiving port, see inputs.conf in the Splunk Enterprise Admin Manual.
If you are collecting metrics data from a *nix host, also configure an HEC token. When you configure an HEC token, set the source type to
em_metrics, and specify the metrics index you want to use. By default, the metrics index is
em_metrics. For more information about configuring an HEC token, see Create an Event Collector token in the Getting Data In guide.
- On the machine that runs the indexer cluster master node, go to the
- open the
inputs.conffile with a text editor.
- Add a
[splunktcp://<port>] disabled = 0
<port>is the port that you want to use to receive data from your host machines. The recommended value is
For more information about configuring
inputs.conf, see inputs.conf in the Admin Manual.
- If you are collecting metrics data from a *nix host, add an HEC token stanza:
[http://<token_name>] disabled = 0 index = em_metrics indexes = em_metrics sourcetype = em_metrics token = <string>
<token_name>is the name of the token and
<string>is a unique identifier for the token value.
- If you have not already enabled global HEC settings, enable HEC now in an
[http] disabled = 0
- Copy the
inputs.conffile to the
4. Push the indexer cluster master node's configuration bundle to the indexer cluster
Splunk_TA_Infrastructure directory and
inputs.conf file to every indexer in the indexer cluster. For more information, see Update common peer configurations and apps.
On the machine that is running the indexer cluster master node, apply the configuration bundle to every indexer in the cluster:
$SPLUNK_HOME/bin/splunk apply cluster-bundle
5. (Optional) Configure a heavy forwarder to collect AWS data
If you haven't already deployed a heavy forwarder that can handle receiving AWS data, first deploy a heavy forwarder. For more information, see Deploy a heavy forwarder in the Splunk Enterprise Forwarding Data guide.
Install these apps and add-ons on the heavy forwarder:
For information about installing apps and add-ons, see Where to get more apps and add-ons in the Splunk Enterprise Admin Manual.
5. (Optional) Deploy a DCN and DCS
You have to deploy a DCN and DCS to collect VMware data. Before you do this, confirm that your indexers have been set up properly. For information about configuring your deployment for VMware data collection, see Install VMware data collection add-ons and dependencies.
To deploy a DCN, see Deploy a Data Collection Node.
To deploy a DCS, see Deploy a Data Collection Scheduler.
6. Configure data collection
Configure data collection for the Splunk App for Infrastructure using the easy install script under the Add Data tab. You can collect data from Linux, Mac OS X, and Windows hosts, Kubernetes and OpenShift clusters, and VMware vCenter Servers.
The easy install script in the Add Data tab cannot set up data forwarding to multiple indexers or a load balancer. If you are sending data to multiple indexers or a load balancer, manually configure data collection.
For information about configuring data collection, see How to add data to Splunk App for Infrastructure in the Administer Splunk App for Infrastructure manual.
For more information on package source, install commands, and install locations for collectd and the collectd plug-in according to the supported operating system, see collectd package sources, install commands, and locations in the Administer Splunk App for Infrastructure manual.
Install the Splunk App for Infrastructure in a single-instance deployment
Install the Splunk App for Infrastructure in a Splunk Cloud deployment
This documentation applies to the following versions of Splunk® App for Infrastructure: 2.0.0, 2.0.1, 2.0.2, 2.0.3, 2.0.4, 2.1.0, 2.1.1 Cloud only