Splunk® App for AWS

Installation and Configuration Manual

Download manual as PDF

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

Install the Splunk App for AWS on Splunk Enterprise

Download the app and the add-on

You can download both the Splunk app and add-on on for AWS on Splunkbase.

  • Splunk App for AWS version 5.1.0.
  • Splunk Add-on for Amazon Web Services version 4.4.0 or later. If you are migrating from an existing installation of the Splunk Add-on for AWS, you can upgrade the add-on in place. The new version of the add-on is backwards compatible with older versions.

Install on a single instance

If your Splunk Enterprise deployment is a single instance, install both the app and the add-on to your single instance. You can use the Install app from file feature in the Manage Apps page in Splunk Web to install both packages, or install manually using the command line.

Install in a non-clustered distributed environment

If your Splunk Enterprise deployment is distributed and non-clustered, follow these steps.

  1. Install both the app and add-on to your search heads.
  2. Turn off add-on visibility on your search heads.
  3. Configure the search head tier to directly forward data to the indexer tier.
  4. Distribute the summary index configurations to the indexer.
  5. Install the add-on to a heavy forwarder.

Install the app and the add-on to your search heads

If you are installing to one or more independent search heads, follow your preferred method of deploying both the app and the add-on. You can:

  • follow the Install app from file wizard on the Manage Apps screen in Splunk Web.
  • install manually using the command line.
  • use a deployment server to deploy the unconfigured packages to your search heads. Do not configure the app or add-on prior to deploying it.

Turn off visibility for the add-on on your search heads

After you have deployed the app and the add-on to your search heads, change the visibility setting for the add-on on each search head to make it not visible. This step helps prevent data duplication errors that can result from running inputs on your search heads instead of (or in addition to) on your data collection node.

  1. Go to Apps > Manage Apps.
  2. Find the Splunk Add-on for AWS, with the folder name Splunk_TA_aws, in the list, and click Edit properties.
  3. Under Visible, click the radio button next to No.
  4. Click Save.
  5. Repeat these steps on all search heads.

Configure the search head tier to directly forward data to the indexer tier

1. Create a outputs.conf file following the example below:

[indexAndForward]
index = false  # Turn off indexing on the search head
[tcpout]
defaultGroup = my_search_peers  # Name of the search peer group
forwardedindex.filter.disable = true
indexAndForward = false 
[tcpout:my_search_peers]
server=10.10.10.1:9997,10.10.10.2:9997,10.10.10.3:9997  # list of peers

2. Place the outputs.conf file under $SPLUNK_HOME/etc/apps/splunk_app_aws/local on the search head.

3. Restart the search head.

Distribute the summary index configurations to the indexer

Copy $SPLUNK_HOME/etc/apps/splunk_app_aws/default/indexes.conf from the search head to a temporary directory on the indexer and then merge all the settings in the file into $SPLUNK_HOME/etc/apps/search/local/indexes.conf to incorporate the summary index configurations.

Install the add-on to heavy forwarders

Follow your preferred method of installing the Splunk Add-on for Amazon Web Services to one or more heavy forwarders. You can:

  • follow the Install app from file wizard on the Manage Apps screen in Splunk Web.
  • install manually using the command line.
  • use a deployment server to deploy the unconfigured packages to your forwarders. Do not configure the app or add-on prior to deploying it.

Note: The add-on does not support universal forwarders or light forwarders because the configuration logic handled by the add-on requires Python. In addition, to configure AWS accounts in the add-on, you must do so using the add-on's configuration UI in Splunk Web rather than in the configuration files.

Install in a clustered distributed environment

To accelerate reporting, the Splunk App for AWS uses summary indexing that builds separate summary indexes on the search head. If you are deploying the Splunk App for AWS in a clustered environment, you need to distribute the summary index configuration bundle across all the clustered indexers and configure your individual or clustered search heads to directly forward data to the indexer tier so that data summary can be shared across all the search heads.

  1. Install the app and the add-on to your search head cluster.
  2. Turn off visibility for the add-on on your search heads.
  3. Configure the search head tier to directly forward data to the indexer tier.
  4. Distribute the summary index configuration bundle across clustered indexers.
  5. Install the add-on to heavy forwarders.

Install the app and the add-on to your search head cluster

Install the app and the add-on using the deployer. See Use the deployer to distribute apps and configuration updates in the Distributed Search manual in the Splunk Enterprise documentation.

To prepare the app and add-on for deployment in a search head cluster, some files must be removed to prevent validation errors on startup:

  1. On the deployer, remove the eventgen.conf file from the add-on folder: $SPLUNK_HOME/etc/shcluster/apps/Splunk_TA_aws/default
  2. On the deployer, remove the inputs.conf file from the add-on folder: $SPLUNK_HOME/etc/shcluster/apps/Splunk_TA_aws/default
  3. On the deployer, remove all files in the folder $SPLUNK_HOME/etc/shcluster/apps/Splunk_TA_aws/samples.

Turn off visibility for the add-on on your search heads

To turn off visibility for the add-on, update the app.conf.

  1. On the deployer, create an app.conf file in the folder $SPLUNK_HOME/etc/shcluster/apps/Splunk_TA_aws/local.
  2. Edit the local/app.conf file.
  3. Turn off visibility using the is_visible setting. Example:
[ui]
is_visible =  false

Configure the search head tier to directly forward data to the indexer tier

1. Create a outputs.conf file following the example below:

[indexAndForward]
index = false  # Turn off indexing on the search head
[tcpout]
defaultGroup = my_search_peers  # Name of the search peer group
forwardedindex.filter.disable = true
indexAndForward = false 
[tcpout:my_search_peers]
server=10.10.10.1:9997,10.10.10.2:9997,10.10.10.3:9997  # list of peers

2. If you use clustered search heads, place the outputs.conf file under $SPLUNK_HOME/etc/shcluster/apps/splunk_app_aws/local and run the splunk apply shcluster-bundle command on the deployer to push the configuration bundle to peers. If you use multiple independent search heads, place the outputs.conf file under $SPLUNK_HOME/etc/apps/splunk_app_aws/local on all the search heads.

3. Restart the search head instances.

Distribute the summary index configuration bundle across clustered indexers

  1. On the indexer cluster master node, merge all the settings from $SPLUNK_HOME/etc/apps/splunk_apps_aws/default/indexes.conf into $SPLUNK_HOME/etc/master-apps/_cluster/local/indexes.conf to incorporate the summary index configurations.
  2. On the master node, run this CLI command to distribute the indexes.conf to the peer nodes:
    splunk apply cluster-bundle

    When the configuration bundle distribution is complete, the indexes.conffile is copied to $SPLUNK_HOME/etc/slave-apps/_cluster/local on the peer nodes.

Install the add-on to heavy forwarders

Follow your preferred method of deploying the Splunk Add-on for Amazon Web Services to one or more heavy forwarders. You can:

  • follow the Install app from file wizard on the Manage Apps screen in Splunk Web.
  • install manually using the command line.
  • use a deployment server to deploy the unconfigured packages to your forwarders. Do not configure the app or add-on prior to deploying it.

Note: The add-on does not support universal forwarders or light forwarders because the configuration logic handled by the add-on requires Python. In addition, to configure AWS accounts in the add-on, you must do so using the add-on's configuration UI in Splunk Web rather than in the configuration files.

PREVIOUS
Install the Splunk App for AWS on Splunk Cloud
  NEXT
Install the Splunk App for AWS on Splunk Light

This documentation applies to the following versions of Splunk® App for AWS: 5.1.0, 5.1.1, 5.1.2, 5.1.3


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