Use the add-on
After you download the add-on package you created using Splunk Add-on Builder, you can use this add-on to get related data in.
The following tasks describe how to set up and configure different aspects of a data input in an add-on created by Splunk Add-on Builder. The example add-on requires an account and password for the data source.
Set up the add-on
The following setup tasks are performed in the Configuration page.
- From the Splunk Web home page, click the name of the add-on in the left navigation panel.
- Click Configuration.
- Create a account with a unique name in the Account field.
- Enter the Username and Password of the account which you want to get data from.
- If you are using a proxy, check Enable and fill in the required fields. If you do not use a proxy, skip this section.
- Select the type of proxy to use in the Proxy Type field.
- Provide the proxy server address in the Host field.
- Provide the proxy server port in the Port field. For example: 8081.
- Provide a proxy username if you have one in the Username field.
- If you provided a proxy username, type the proxy password in the Password field.
- Check the Remote DNS resolution box if you want to perform DNS resolution through your proxy.
- To change the Log level, select a new level from the drop down menu.
Configure the inputs to collect data via Splunk Web. Click Create New Input in the Inputs tab and configure the following.
- Enter a Name, Interval and Index.
Name: The name of the input.
Index: The index in which you want the Splunk platform to store indexed data.
Interval: The number of seconds to wait before the Splunk platform runs the command again.
Choose the Checkpoint type and enter the checkpoint value. If you need more details on setting modular input checkpoints, see Data checkpoints in Developing Views and Apps for Splunk Web.
Checkpoint type: There are two checkpoint type, Auto and File.
- If you choose Auto, the checkpoint file will be saved in the KVstore.
- If you choose File, the checkpoint file will be saved under folder
- Restart the Splunk platform.
Validate and package
Create a new data model
This documentation applies to the following versions of Splunk® Add-on Builder: 3.0.0, 3.0.0, 3.0.1