The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Splunk Plugin

step([$class: 'SplunkArtifactNotifier']): Send files to Splunk

  • includeFiles : String
  • excludeFiles : String
  • publishFromSlave : boolean
    Publish log files directly from the agent, instead of proxy for the process to the master. When publish from agent is selected, Jenkins master will transfer the plugin and its dependence to agent and initiate the publishing process from the agent. Take below into consideration:
    • agent and master load
    • log file size
    • agent type, long lived agent or one time use agent
    Rule of thumb for selecting publish type:
    • a. if log files size is less than 5MB, publish from master is preferred.
    • b. if Splunk instance is in an isolated network which is not reachable from agent, you need publish from master.
  • skipGlobalSplunkArchive : boolean
    To skip the global post job archiving DSL e.g. archive("**/*.log") when the DSL does not fit for specific set of job.
  • sizeLimit : String
    Limit the single file size to prevent publishing the whole huge log file generated accidentally by some program and uses up your Splunk daily volume license. The plugin will log a "file truncated to size:xx" event in Splunk when size limit is reached and will stop publishing the remaining content.

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?


See existing feedback here.