Create Splunk plugin procedures

2 minute readExtensibilityDeveloper productivity
On this page

Plugin procedures can be used in procedure steps, process steps, and pipeline tasks, allowing you to orchestrate third-party tools at the appropriate time in your component, application process, or pipeline.

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.

SendLogs

Sends logs to Splunk using HEC or TCP endpoint.

Input parameters

Table 1. SendLogs input parameters
Parameter Description

Configuration name

Required. Name of the configuration containing your Splunk endpoint information.

Source for HEC

The source value to assign to the event data. For example, if you are developing an application and sending data from it, you could set this key to the application name.

This field is only used if Splunk Endpoint Type is set to HTTP Event Collector.

Source type for HEC

The HEC sourcetype value to assign to event data.

This field is only used if Splunk Endpoint Type is set to HTTP Event Collector.

Index for HEC

Name of the index that the event data is indexed by. If the token has the indexes parameter set, this index must appear in the allowed indexes list.

This field is only used if Splunk Endpoint Type is set to HTTP Event Collector.

Enable streaming?

Required. If checked, log files are sent using streaming. If disabled, log files are sent in a single request.

For sending large log files, streaming reduces large payloads by sending logs line by line.

Filter CloudBees CD/RO logs?

Required. If checked, logs created by CloudBees CD/RO are not sent by the SendLogs procedure.

Files pattern

Required. The pattern to define which files are sent to Splunk. For example, to send all .log files, use *.log.

Path to logs folder

Folder path where logs are stored. If not specified, the default folder path is COMMANDER_WORKSPACE.