sendalert command is an internal, unsupported, experimental command. See
About internal commands.
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.
sendalert <alert_action_name> [results_link=<url>] [results_path=<path>] [param.<name>=<"value">...]
- Syntax: <alert_action_name>
- Description: The name of the alert action configured in the
- Syntax: results_link=<url>
- Description: Set the URL link to the search results.
- Syntax: results_path=<path>
- Description: Set the location to the file containing the search results.
- 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.
When you use the
sendalert command in an ad hoc search, the command might be called multiple times if there are a large number of search results. This occurs because previewing the search results on the Statistics tab is enabled by default. If you are using an ad hoc search to test the
sendalert command, testing turn off preview to avoid the command being called multiple times.
sendalert command is included in a saved search, such as a scheduled report or a scheduled search, the command is called only one time.
Search results format
sendalert command is used in a search or in an alert action, the search results are stored in an archive file in the dispatch directory using the CSV format. The file name is
results.csv.gz. The default format for the search results is SRS, a Splunk-specific binary format for the search results. The CSV format for the archive file is used so that scripts can process the results file. The default SRS format is not designed to be parsed by scripts.
The archived search results format is controlled through the
forceCsvResults setting. This setting is in the [default] stanza in the
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"
About searches in the CLI
This documentation applies to the following versions of Splunk® Enterprise: 7.2.0, 7.2.1, 7.2.2, 7.2.3, 7.2.4, 7.2.5, 7.2.6, 7.2.7, 7.2.8, 7.2.9, 7.2.10, 7.3.0, 7.3.1, 7.3.2, 7.3.3, 7.3.4, 7.3.5, 7.3.6, 7.3.7, 7.3.8, 7.3.9, 8.0.0, 8.0.1, 8.0.2, 8.0.3, 8.0.4, 8.0.5, 8.0.6, 8.0.7, 8.0.8, 8.0.9, 8.0.10, 8.1.0, 8.1.1, 8.1.2, 8.1.3, 8.1.4, 8.1.5, 8.1.6, 8.1.7, 8.1.8, 8.2.0, 8.2.1, 8.2.2, 8.2.3, 8.2.4