Install the Splunk Add-on for NGINX¶
- Get the Splunk Add-on for NGINX by downloading it from Splunkbase or browsing to it using the app browser within Splunk Web.
- Determine where and how to install this add-on in your deployment, using the tables on this page.
- Perform any prerequisite steps before installing, if required and specified in the tables on this page.
- Complete your installation.
If you need step-by-step instructions on how to install an add-on in your specific deployment environment, see Installation walkthroughs at the bottom of this page for links to single-instance, distributed, and Splunk Cloud deployment instructions.
Distributed deployments¶
Use the tables on this page to determine where and how to install this add-on in a distributed deployment of Splunk Enterprise, or in any deployment that uses forwarders for data collection. Depending on your environment, preferences, and add-on requirements, you might need to install the add-on in multiple places.
Where to install this add-on¶
Unless otherwise noted, all supported add-ons can be safely installed to all tiers of a distributed Splunk platform deployment. See Where to install Splunk add-ons in Splunk Add-ons for more information.
This table provides a reference for installing this specific add-on to a distributed deployment of Splunk Enterprise.
| Splunk instance type | Supported | Required | Comments |
|---|---|---|---|
| Search heads | Yes | Yes | Install this add-on to all search heads where NGINX knowledge management is required. |
| Indexers | Yes | Conditional | Not required if you use heavy forwarders to collect data. Required if you use universal forwarders to collect data. |
| Heavy forwarders | Yes | Conditional | Required for the NGINX status API input. Optional file monitoring inputs. The file monitoring inputs must be enabled on a forwarder that is installed directly on the machine running your NGINX server. |
| Universal forwarders | Yes | Conditional | Not supported for NGINX status API inputs. Supported only for file monitoring inputs. The file monitoring inputs must be enabled on a forwarder that is installed directly on the machine running your NGINX server. |
Distributed deployment feature compatibility¶
This table describes the compatibility of this add-on with Splunk distributed deployment features.
| Distributed deployment feature | Supported | Actions required |
|---|---|---|
| Search head clusters | Yes | Disable add-on visibility on search heads. You can install this add-on on a search head cluster for all search-time functionality, but configure inputs on forwarders to avoid duplicate data collection. |
| Indexer clusters | Yes | |
| Deployment server | No | Supported for deploying unconfigured add-ons only. Note: Using a deployment server to deploy the configured add-on to multiple forwarders acting as data collectors causes duplication of data. |
Installation walkthroughs¶
The Splunk Add-Ons manual includes an Installing add-ons guide that helps you successfully install any Splunk-supported add-on to your Splunk platform.
For a walkthrough of the installation procedure, follow the link that matches your deployment scenario: