NetApp StorageGRID App for Splunk

This is an app powered by the Splunk Add-on Builder.

Overview

The NetApp StorageGRID App for Splunk is used to build dashboards and run ad-hoc searches on top of the data collected and indexed by the NetApp StorageGRID Add-on for Splunk. The NetApp StorageGRID Add-on for Splunk can be downloaded from here

Compatibility Matrix

Splunk version: 8.2.x, 8.1.x
NetApp StorageGRID 11.x.
OS Support: Linux (Centos, Ubuntu) and Windows
Browser Support: Chrome and Firefox

Recommended System Configuration

Splunk forwarder system should have 4 GB of RAM and a quad-core CPU to run this app smoothly.

Topology and Setting up Splunk Environment

Prerequisite

This app has been distributed in two parts.

Install NetApp StorageGRID Add-on for Splunk, which runs collector scripts and gathers data from StorageGRID, does indexing and parsing on collected data.
Install NetApp StorageGRID App for Splunk, which receives indexed data from NetApp StorageGRID Add-on for Splunk, runs searches on it and builds dashboards.

This App is supported on the Search head in case of distributed Splunk platform deployment and also on standalone Splunk instance. Below table provides the reference for installing the App on distributed Splunk deployment:

Splunk instance type	Supported	Required	Comments
Search Heads	Yes	Yes	This App is required on Search Heads as it has dashboards and searches.
Indexers	Yes	No	This App is not required on the indexers.
Heavy Forwarders	Yes	No	This App is not required on the heavy forwarders.

Installation

Follow the link mentioned below to install the App based on your deployment:

Upgrade the App

If there is already older version of app installed in your Splunk instance, then you can upgrade app by following two ways:

Using the latest version available on Splunkbase.
- From the Splunk Web home screen, click the gear icon next to Apps.
- There will be option to update the App to the latest version in column name as - "Version".
- Click on "Update to [version]"
- Follow the installation steps to update the App.
You can download latest version of App from Splunkbase and you can upload it into Splunk by navigating to
- From the Splunk Web home screen, click the gear icon next to Apps.
- Click on, Install app from file -> Choose File
- Choose the location of App's build downloaded and make sure you have checked checkbox of "Upgrade app."
- And then click on Upload
- Restart the Splunk

Configuration

Admin will have to update/replace name of the index in 'get_sg_index' macro if StorageGRID data is being indexed in any index other than main. There is no additional configuration required.

Update index in macro

On Splunk web go to Settings > Advanced search > Search macros.
Select NetApp StorageGRID App for Splunk in App. Change Visible in the App to Created in the App.
Search for macro name get_sg_index and click on it to edit.
Change definition of macro with the new index or indexes configured.
Ex. (index=storagegrid)
Click on Save.

Lookups

sg_account_mapping - This is CSV file based lookup which consists details of tenant accounts having their names and ids.
sg_hierarchy - This is CSV file based lookup which consists details about hierarchy of configured storageGrid.
sg_storagenode_mapping - This is CSV file based lookup which consists details of all storage nodes.

Saved Searches

This app contains the following saved searches, which are used for populating data in the dashboard:

SG-accountMappingLookup - Used to populate - "sg_account_mapping" lookup and is triggered at an interval of 15 minutes.
SG-hierarchyLookup - Used to populate - "sg_hierarchy" lookup and is triggered at an interval of 15 minutes.
SG-storagenodeMappingLookup - Used to populate - "sg_storagenode_mapping" lookup and is triggered at an interval of 15 minutes.

OPEN SOURCE COMPONENTS AND LICENSES

Some of the components included in "NetApp StorageGRID App for Splunk" are licensed under free or open source licenses. We wish to thank the contributors to those projects.
jQuery version 3.6.0 http://jquery.com/ (LICENSE https://github.com/jquery/jquery/blob/master/LICENSE.txt)
Underscore JS version 1.6.0 http://underscorejs.org (LICENSE https://github.com/jashkenas/underscore/blob/master/LICENSE)

UNINSTALL & CLEANUP STEPS

Remove $SPLUNK_HOME/etc/apps/netapp_app-sg
To reflect the cleanup changes in UI, Restart Splunk Enterprise instance

Troubleshooting

Test Your Install

The main app dashboard can take some time to populate the dashboards Once data collection is started by Add-on. A good test to see that you are receiving all of the expected data is to run below given search on Main app search dashboard after several minutes:

search `get_sg_index` | stats count by sourcetype

In particular, you should see these sourcetypes:

grid:rest:api
grid:auditlog

If you don't see these sourcetypes

Verify the macro configurations in the App. Refer to "Configuration > Update index in macro" section for more details.
Please check troubleshooting guide for the NetApp StorageGRID Add-on for Splunk.

If the dashboard filters are not being populated

Make sure all the saved-searches in the App is enabled.
Try restarting Splunk search head. In standalone restart Splunk.

Support

Support Information: Community Supported

Copyright (C) 2022 NetApp. All rights reserved.