Splunk® Add-on Builder

Splunk Add-on Builder User Guide

Download manual as PDF

Download topic as PDF

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.

  1. From the Splunk Web home page, click the name of the add-on in the left navigation panel.
  2. Click Configuration.

The following example demonstrates how to set up and configure 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, and uses checkpointing

Set up the add-on

Account settings

AOB2.2 account.jpg

  1. Create a account with a unique name in the Account field.
  2. Enter the Username and Password of the account which you want to get data from.

Proxy settings

AOB2.2 proxy.jpg

  1. If you are using a proxy, check Enable and fill in the required fields. If you do not use a proxy, skip this section.
  2. Select the type of proxy to use in the Proxy Type field.
  3. Provide the proxy server address in the Host field.
  4. Provide the proxy server port in the Port field. For example: 8081.
  5. Provide a proxy username if you have one in the Username field.
  6. If you provided a proxy username, type the proxy password in the Password field.
  7. Check the Remote DNS resolution box if you want to perform DNS resolution through your proxy.

Logging Settings

AOB2.2 loglevel.jpg

  1. If you want to change the Log level, select a new level from the drop down menu.

Configure inputs

AOB2.2 checkpoint.jpg

After you set up the add-on, you can configure the inputs to collect data via Splunk Web. Click Create New Input in the Inputs tab and configure the following.

  1. 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.
  2. 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 $SPLUNK_HOME$/var/lib/splunk/modinputs
  3. Restart the Splunk platform after configuring the inputs
PREVIOUS
Validate and package
  NEXT
Create a new data model

This documentation applies to the following versions of Splunk® Add-on Builder: 2.2.0


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