Splunk Cloud

Search Reference

Download manual as PDF

Download topic as PDF

sendalert

Description

Use the sendalert command to invoke a custom alert action. The command gathers the configuration for the alert action from the alert_actions.conf file and the saved search and custom parameters passed using the command arguments. Then the command performs token replacement. The command determines the alert action script and arguments to run, creates the alert action payload and executes the script, handing over the payload by using STDIN to the script process.

When running the custom script, the sendalert command honors the maxtime setting from the alert_actions.conf file and terminates the process if the process runs longer than the configured threshold. By default the threshold is set to 5 minutes.

See "Advanced options for working with custom alert actions" in the Developing Views and Apps for Splunk Web manual.

Syntax

sendalert <alert_action_name> [results_link=<url>] [results_path=<path>] [param.<name>=<"value">...]

Required arguments

alert_action_name
Syntax: <alert_action_name>
Description: The name of the alert action configured in the alert_actions.conf file

Optional arguments

results_link
Syntax: results_link=<url>
Description: Set the URL link to the search results.
results_path
Syntax: results_path=<path>
Description: Set the location to the file containing the search results.
param.<name>
Syntax: param.<name>=<"value">
Description: The parameter name and value. You can use this name and value pair to specify a variety of things, such as a threshold value, a team name, or the text of a message.

Usage

When you use the sendalert command in an ad hoc search, the command is called multiple times if preview is enabled, which is the default, and there are a large number of search results.

When the sendalert command is included in a saved search, such as a scheduled report or a scheduled search, the command is called only one time.

Examples

Example 1: Invoke an alert action without any arguments. The alert action script handles checking whether there are necessary parameters that are missing and report the error appropriately.

... | sendalert myaction

Example 2: Trigger the hipchat custom alert action and pass in room and message as custom parameters.

... | sendalert hipchat param.room="SecOps" param.message="There is a security problem!"

Example 3: Trigger the servicenow alert option.

... | sendalert servicenow param.severity="3" param.assigned_to="DevOps" param.short_description="Splunk Alert: this is a potential security issue"

PREVIOUS
runshellscript
  NEXT
About searches in the CLI

This documentation applies to the following versions of Splunk Cloud: 6.6.3, 7.1.3, 7.0.2, 7.0.3, 7.0.5, 7.0.0


Comments

Sylim, thanks for this info. I've added to the documentation above.

Lstewart splunk, Splunker
August 13, 2018

When sendalert used in GUI, like <search > | sendalert
- It will be called multiple times if preview is enabled (by default, true) and search results are more than a certain amount.
- It doesn't happen when it returns small set of results even if preview is enabled.

When sendalert is used in Saved searches
- Only called once.

Sylim splunk, Splunker
August 9, 2018

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