Splunk Web Adapter

This page documents the edgeCore Web Adapter for Splunk.

  • Vendor: Splunk
  • Product Name: Splunk
  • Supported Version(s): 6.3, 7.1
  • Name of edgeSuite Web Adapter: splunk.splunk-2.0.4.zip
  • Required edgeSuite Version: 2.0 and above

Support Matrix #

This section details the supported/required operating system, database, and browser for this Web Adapter.

Operating System #

Please see the list of supported Operating Systems in the System Requirements section of the Installation page.

Database #

A special database is not required to implement this integration module. The edgeCore configuration database is used to store all configurations related to this Web Adapter.

Browser #

Please see the list of supported Web Browsers in the System Requirements section of the Installation page.

Installation #

Perform the following steps to install the Web Adapter:

  1. Install edgeCore as detailed in the Installation documentation.
  2. Request the file splunk.splunk-2.0.4.zip from Edge Support.
  3. Download the file to the edgeSuite server.
  4. Place the file in the directory: [INSTALL_HOME]/modules/
  5. Log in to edgeCore as an administrator.
  6. Go to the “Installed Adapters” page, located under System Menu → Manage → Adapters.
  7. Click the [+] button at the bottom left to show the list of available adapters.
  8. Select the desired adapter and click Install. A confirmation dialog will be shown if only one version is available, otherwise a list of versions (only newer if upgrading) is shown to choose from.
  9. Look for the “Installed Successfully” message and click the Close button.

Adapter Details #

The following sections provide special details for configuring the Web Adapter after installation.

Single Sign-on #

The Splunk Web Adapter includes an SSO Handler for managing Single Sign-on. When configuring the Endpoint step for a Splunk connection, select “SplunkSso” from the drop-down list for the SSO Handler setting.

Feed Types #

Four feed types are provided with the Splunk Web Adapter:

  1. Generic Web Content – Used for accessing the Splunk top-level Home page, with the “BaseWeb” Rule Name pre-selected as the web rules configuration..
  2. Splunk Base – Used for accessing the Splunk top-level Home page, with the “Splunk” Rule Name pre-selected as the web rules configuration.
  3. Splunk Datasets – Used for accessing the URI: /en-US/app/search/datasets
  4. Splunk Search – Used for accessing the URI: /en-US/app/search/search?q=search%20{nodeVar.splunkSearchTerm}

Known Issues #

There are currently not any known issues associated with this Web Adapter.

Version Support #

Package Name
edgeSuite Version
Splunk Version
Package Name
edgeSuite Version
Splunk Version
splunk.splunk-1.0.0-beta1.zip 2.0+ 6.3
splunk.splunk-1.0.0-beta3.zip 2.0+ 6.3
splunk.splunk-2.0.4.zip 2.0+ 6.3, 7.1

Upgrade #

Perform the following steps to upgrade the Web Adapter to a newer version:

  1. Request the updated Web Adapter file from Edge Support.
  2. Download the file to the edgeSuite server.
  3. Place the file in the directory: [INSTALL_HOME]/modules/
  4. Log in to edgeSuite as an administrator.
  5. Go to the “Installed Adapters” page, located under System Menu → Manage → Adapters.
  6. Look in the “Status” column for the installed Web Adapter. It will say “Update Available”.
  7. Mouse over the “Update Available” message (button) to confirm the version of the available Web Adapter update.
  8. Click the “Update Available” button.
  9. Click “Update” in the confirmation dialog.
  10. Look for the “Installed Successfully” message and click the Close button.

Uninstall #

This section TBD.

Need to confirm if there is any formal way to uninstall a Web Adapter.