@placement search-head # Version 20170103 # # This file contains possible attribute/value pairs for saved search entries in # savedsearches.conf. You can configure saved searches by creating your own # savedsearches.conf. # # There is a default savedsearches.conf in $SPLUNK_HOME/etc/system/default. To # set custom configurations, place a savedsearches.conf in # $SPLUNK_HOME/etc/system/local/. For examples, see # savedsearches.conf.example. You must restart Splunk to enable configurations. # # To learn more about configuration files (including precedence) please see the # documentation located at # http://docs.splunk.com/Documentation/Splunk/latest/Admin/Aboutconfigurationfiles # GLOBAL SETTINGS # Use the [default] stanza to define any global settings. # * You can also define global settings outside of any stanza, at the top of # the file. # * Each conf file should have at most one default stanza. If there are # multiple default stanzas, attributes are combined. In the case of multiple # definitions of the same attribute, the last definition in the file wins. # * If an attribute is defined at both the global level and in a specific # stanza, the value in the specific stanza takes precedence. #******* # The possible attribute/value pairs for savedsearches.conf are: #******* [] * Create a unique stanza name for each saved search. * Follow the stanza name with any number of the following attribute/value pairs. * If you do not specify an attribute, Splunk uses the default. disabled = [0|1] * Disable your search by setting to 1. * A disabled search cannot run until it is enabled. * This setting is typically used to keep a scheduled search from running on its schedule without deleting the search definition. * Defaults to 0. search = * Actual search terms of the saved search. * For example, search = index::sampledata http NOT 500. * Your search can include macro searches for substitution. * To learn more about creating a macro search, search the documentation for "macro search." * Multi-line search strings currently have some limitations. For example use with the search command '|savedseach' does not currently work with multi-line search strings. * Defaults to empty string. dispatchAs = [user|owner] * When the saved search is dispatched via the "saved/searches/{name}/dispatch" endpoint, this setting controls, what user that search is dispatched as. * This setting is only meaningful for shared saved searches. * When dispatched as user it will be executed as if the requesting user owned the search. * When dispatched as owner it will be executed as if the owner of the search dispatched it no matter what user requested it. * If the 'force_saved_search_dispatch_as_user' attribute, in the limits.conf file, is set to true then the dispatchAs attribute is reset to 'user' while the saved search is dispatching. * Defaults to owner. #******* # Scheduling options #******* enableSched = [0|1] * Set this to 1 to run your search on a schedule. * Defaults to 0. cron_schedule = * The cron schedule used to execute this search. * For example: */5 * * * * causes the search to execute every 5 minutes. * Cron lets you use standard cron notation to define your scheduled search interval. In particular, cron can accept this type of notation: 00,20,40 * * * *, which runs the search every hour at hh:00, hh:20, hh:40. Along the same lines, a cron of 03,23,43 * * * * runs the search every hour at hh:03, hh:23, hh:43. * Splunk recommends that you schedule your searches so that they are staggered over time. This reduces system load. Running all of them every 20 minutes (*/20) means they would all launch at hh:00 (20, 40) and might slow your system every 20 minutes. * Splunk's cron implementation does not currently support names of months/days. * Defaults to empty string. schedule = * This field is DEPRECATED as of 4.0. * For more information, see the pre-4.0 spec file. * Use cron_schedule to define your scheduled search interval. max_concurrent = * The maximum number of concurrent instances of this search the scheduler is allowed to run. * Defaults to 1. realtime_schedule = [0|1] * Controls the way the scheduler computes the next execution time of a scheduled search. * If this value is set to 1, the scheduler bases its determination of the next scheduled search execution time on the current time. * If this value is set to 0, the scheduler bases its determination of the next scheduled search on the last search execution time. This is called continuous scheduling. * If set to 1, the scheduler might skip some execution periods to make sure that the scheduler is executing the searches running over the most recent time range. * If set to 0, the scheduler never skips scheduled execution periods. * However, the execution of the saved search might fall behind depending on the scheduler's load. Use continuous scheduling whenever you enable the summary index option. * The scheduler tries to execute searches that have realtime_schedule set to 1 before it executes searches that have continuous scheduling (realtime_schedule = 0). * Defaults to 1 schedule_priority = default | higher | highest * Raises scheduling priority of a search: + "default": No scheduling priority increase. + "higher": Scheduling priority is higher than other searches of the same scheduling tier. While there are four tiers of priority for scheduled searches, only the following are affected by this property: 1. Real-Time-Scheduled (realtime_schedule=1). 2. Continuous-Scheduled (realtime_schedule=0). + "highest": Scheduling priority is higher than other searches regardless of scheduling tier. However, real-time-scheduled searches with priority = highest always have priority over continuous scheduled searches with priority = highest. + Hence, the high-to-low order (where RTSS = real-time-scheduled search, CSS = continuous-scheduled search, d = default, h = higher, H = highest) is: RTSS(H) > CSS(H) > RTSS(h) > RTSS(d) > CSS(h) > CSS(d) * The scheduler honors a non-default priority only when the search owner has the 'edit_search_schedule_priority' capability. * Defaults to "default". * A non-default priority is mutually exclusive with a non-zero 'schedule_window' (see below). If a user specifies both for a scheduled search, the scheduler honors the priority only. * However, if a user specifies both settings for a search, but the search owner does not have the 'edit_search_scheduler_priority' capability, then the scheduler ignores the priority setting and honors the 'schedule_window'. * WARNING: Having too many searches with a non-default priority will impede the ability of the scheduler to minimize search starvation. Use this setting only for mission-critical searches. schedule_window = | auto * When schedule_window is non-zero, it indicates to the scheduler that the search does not require a precise start time. This gives the scheduler greater flexibility when it prioritizes searches. * When schedule_window is set to an integer greater than 0, it specifies the "window" of time (in minutes) a search may start within. + The schedule_window must be shorter than the period of the search. + Schedule windows are not recommended for searches that run every minute. * When set to 0, there is no schedule window. The scheduler starts the search as close to its scheduled time as possible. * When set to "auto," the scheduler calculates the schedule_window value automatically. + For more information about this calculation, see the search scheduler documentation. * Defaults to 0 for searches that are owned by users with the edit_search_schedule_window capability. For such searches, this value can be changed. * Defaults to "auto" for searches that are owned by users that do not have the edit_search_window capability. For such searches, this setting cannot be changed. * A non-zero schedule_window is mutually exclusive with a non-default schedule_priority (see schedule_priority for details). #******* # Notification options #******* counttype = number of events | number of hosts | number of sources | custom | always * Set the type of count for alerting. * Used with relation and quantity (below). * NOTE: If you specify "always," do not set relation or quantity (below). * Defaults to always. relation = greater than | less than | equal to | not equal to | drops by | rises by * Specifies how to compare against counttype. * Defaults to empty string. quantity = * Specifies a value for the counttype and relation, to determine the condition under which an alert is triggered by a saved search. * You can think of it as a sentence constructed like this: . * For example, "number of events [is] greater than 10" sends an alert when the count of events is larger than by 10. * For example, "number of events drops by 10%" sends an alert when the count of events drops by 10%. * Defaults to an empty string. alert_condition = * Contains a conditional search that is evaluated against the results of the saved search. Alerts are triggered if the specified search yields a non-empty search result list. * Defaults to an empty string. #******* # generic action settings. # For a comprehensive list of actions and their arguments, refer to # alert_actions.conf. #******* action. = 0 | 1 * Indicates whether the action is enabled or disabled for a particular saved search. * The action_name can be: email | populate_lookup | script | summary_index * For more about your defined alert actions see alert_actions.conf. * Defaults to an empty string. action.. = * Overrides an action's parameter (defined in alert_actions.conf) with a new for this saved search only. * Defaults to an empty string. #****** # Settings for email action #****** action.email = 0 | 1 * Enables or disables the email action. * Defaults to 0. action.email.to = * REQUIRED. This setting is not defined in alert_actions.conf. * Set a comma-delimited list of recipient email addresses. * Defaults to empty string. * When configured in Splunk Web, the following email settings are written to this conf file only if their values differ from settings in alert_actions.conf. action.email.from = * Set an email address to use as the sender's address. * Defaults to splunk@ (or whatever is set in alert_actions.conf). action.email.subject = * Set the subject of the email delivered to recipients. * Defaults to SplunkAlert- (or whatever is set in alert_actions.conf). action.email.mailserver = * Set the address of the MTA server to be used to send the emails. * Defaults to (or whatever is set in alert_actions.conf). action.email.maxresults = * Set the maximum number of results to be emailed. * Any alert-level results threshold greater than this number will be capped at this level. * This value affects all methods of result inclusion by email alert: inline, CSV and PDF. * Note that this setting is affected globally by "maxresults" in the [email] stanza of alert_actions.conf. * Defaults to 10000 action.email.include.results_link = [1|0] * Specify whether to include a link to search results in the alert notification email. * Defaults to 1 (or whatever is set in alert_actions.conf). action.email.include.search = [1|0] * Specify whether to include the query whose results triggered the email. * Defaults to 0 (or whatever is set in alert_actions.conf). action.email.include.trigger = [1|0] * Specify whether to include the alert trigger condition. * Defaults to 0 (or whatever is set in alert_actions.conf). action.email.include.trigger_time = [1|0] * Specify whether to include the alert trigger time. * Defaults to 0 (or whatever is set in alert_actions.conf). action.email.include.view_link = [1|0] * Specify whether to include saved search title and a link for editing the saved search. * Defaults to 1 (or whatever is set in alert_actions.conf). action.email.inline = [1|0] * Specify whether to include search results in the body of the alert notification email. * Defaults to 0 (or whatever is set in alert_actions.conf). action.email.sendcsv = [1|0] * Specify whether to send results as a CSV file. * Defaults to 0 (or whatever is set in alert_actions.conf). action.email.sendpdf = [1|0] * Specify whether to send results as a PDF file. * Defaults to 0 (or whatever is set in alert_actions.conf). action.email.sendresults = [1|0] * Specify whether to include search results in the alert notification email. * Defaults to 0 (or whatever is set in alert_actions.conf). #****** # Settings for script action #****** action.script = 0 | 1 * Enables or disables the script action. * 1 to enable, 0 to disable. * Defaults to 0 action.script.filename =