Create Splunk plugin configurations

2 minute readExtensibilityDeveloper productivity

Plugin configurations are sets of parameters that can be applied across some, or all, plugin procedures. They can reduce the repetition of common values, create predefined parameter sets, and securely store credentials. Each configuration is given a unique name that is entered in the designated parameter for the plugin procedures that use them. The following steps illustrate how to create a plugin configuration that can be used by one or more plugin procedures.

To create a plugin configuration:

  1. Navigate to DevOps Essentials  Plugin Management  Plugin configurations.

  2. Select Add plugin configuration to create a new configuration.

  3. In the New Configuration window, specify a Name for the configuration.

  4. Select the Project that the configuration belongs to.

  5. Optionally, add a Description for the configuration.

  6. Select the appropriate Plugin for the configuration.

  7. Configure the plugin configuration parameters.

  8. Select OK.

Depending on your plugin configuration and how you run procedures, the Input parameters  Configuration name field may behave differently in the CloudBees CD/RO UI. For more information, refer to Differences in plugin UI behavior.

Splunk plugin configuration parameters

Table 1. EC-Splunk plugin configuration parameters
Parameter Description

Configuration

Required. Unique name for the plugin configuration.

Description

Description for the plugin configuration.

Splunk endpoint type

Required. Splunk Endpoint Type, either HTTP Event Collector (HEC) or TCP.

Splunk endpoint address

Required. Address of your Splunk endpoint. For example, https://splunk-host:8088 for HEC or splunk-host:9995 for TCP.

Splunk HEC token

Splunk HEC Token. If Splunk Endpoint Type is set to HTTP Event Collector, this field is required.

Debug level

This option sets the debug level for logs. If Info is selected, only a summary is displayed. If Debug is selected, debug information is displayed. If Trace is selected, all requests and responses are displayed.