[role="xpack"]
[[notification-settings]]
=== {watcher} settings in Elasticsearch
[subs="attributes"]
++++
{watcher} settings
++++
[[notification-settings-description]]
// tag::notification-settings-description-tag[]
You configure {watcher} settings to set up {watcher} and send notifications via
<>,
<>, and
<>.
All of these settings can be added to the `elasticsearch.yml` configuration file,
with the exception of the secure settings, which you add to the {es} keystore.
For more information about creating and updating the {es} keystore, see
<>. Dynamic settings can also be updated across a cluster with the
<>.
// end::notification-settings-description-tag[]
[discrete]
[[general-notification-settings]]
==== General Watcher Settings
`xpack.watcher.enabled`::
Set to `false` to disable {watcher} on the node.
[[xpack-watcher-encrypt-sensitive-data]]
// tag::watcher-encrypt-sensitive-data-tag[]
`xpack.watcher.encrypt_sensitive_data` {ess-icon}::
Set to `true` to encrypt sensitive data. If this setting is enabled, you
must also specify the `xpack.watcher.encryption_key` setting. For more
information, see <>.
// end::watcher-encrypt-sensitive-data-tag[]
`xpack.watcher.encryption_key` (<>)::
Specifies the path to a file that contains a key for encrypting sensitive data.
If `xpack.watcher.encrypt_sensitive_data` is set to `true`, this setting is
required. For more information, see <>.
[[xpack-watcher-history-cleaner-service]]
// tag::watcher-history-cleaner-service-tag[]
`xpack.watcher.history.cleaner_service.enabled` {ess-icon}::
added:[6.3.0,Default changed to `true`.]
deprecated:[7.0.0,Watcher history indices are now managed by the `watch-history-ilm-policy` ILM policy]
+
Set to `true` (default) to enable the cleaner service. The cleaner service
removes previous versions of {watcher} indices (for example,
`.watcher-history*`) when it determines that they are old. The duration of
{watcher} indices is determined by the `xpack.monitoring.history.duration`
setting, which defaults to 7 days. For more information about that setting,
see <>.
// end::watcher-history-cleaner-service-tag[]
`xpack.http.proxy.host`::
Specifies the address of the proxy server to use to connect to HTTP services.
`xpack.http.proxy.port`::
Specifies the port number to use to connect to the proxy server.
`xpack.http.default_connection_timeout`::
The maximum period to wait until abortion of the request, when a
connection is being initiated.
`xpack.http.default_read_timeout`::
The maximum period of inactivity between two data packets, before the
request is aborted.
`xpack.http.max_response_size`::
Specifies the maximum size an HTTP response is allowed to have, defaults to
`10mb`, the maximum configurable value is `50mb`.
`xpack.http.whitelist`::
A list of URLs, that the internal HTTP client is allowed to connect to. This
client is used in the HTTP input, the webhook, the slack, pagerduty,
and jira actions. This setting can be updated dynamically. It defaults to `*`
allowing everything. Note: If you configure this setting and you are using one
of the slack/pagerduty actions, you have to ensure that the
corresponding endpoints are explicitly allowed as well.
[[ssl-notification-settings]]
:ssl-prefix: xpack.http
:component: {watcher} HTTP
:verifies:
:server!:
:ssl-context: watcher
include::ssl-settings.asciidoc[]
[discrete]
[[email-notification-settings]]
==== Email Notification Settings
You can configure the following email notification settings in
`elasticsearch.yml`. For more information about sending notifications
via email, see <>.
`xpack.notification.email.account`::
Specifies account information for sending notifications via email. You
can specify the following email account attributes:
+
--
[[email-account-attributes]]
`profile` (<>);;
The <> to use to build the MIME
messages that are sent from the account. Valid values: `standard`, `gmail` and
`outlook`. Defaults to `standard`.
`email_defaults.*` (<>);;
An optional set of email attributes to use as defaults
for the emails sent from the account. See
<> for the supported
attributes.
`smtp.auth` (<>);;
Set to `true` to attempt to authenticate the user using the
AUTH command. Defaults to `false`.
`smtp.host` (<>);;
The SMTP server to connect to. Required.
`smtp.port` (<>);;
The SMTP server port to connect to. Defaults to 25.
`smtp.user` (<>);;
The user name for SMTP. Required.
`smtp.secure_password` (<>);;
The password for the specified SMTP user.
`smtp.starttls.enable` (<>);;
Set to `true` to enable the use of the `STARTTLS`
command (if supported by the server) to switch the connection to a
TLS-protected connection before issuing any login commands. Note that
an appropriate trust store must be configured so that the client will
trust the server's certificate. Defaults to `false`.
`smtp.starttls.required` (<>);;
If `true`, then `STARTTLS` will be required. If that command fails, the
connection will fail. Defaults to `false`.
`smtp.ssl.trust` (<>);;
A list of SMTP server hosts that are assumed trusted and for which
certificate verification is disabled. If set to "*", all hosts are
trusted. If set to a whitespace separated list of hosts, those hosts
are trusted. Otherwise, trust depends on the certificate the server
presents.
`smtp.timeout` (<>);;
The socket read timeout. Default is two minutes.
`smtp.connection_timeout` (<>);;
The socket connection timeout. Default is two minutes.
`smtp.write_timeout` (<>);;
The socket write timeout. Default is two minutes.
`smtp.local_address` (<>);;
A configurable local address when sending emails. Not configured by default.
`smtp.local_port` (<>);;
A configurable local port when sending emails. Not configured by default.
`smtp.send_partial` (<>);;
Send an email, despite one of the receiver addresses being invalid.
`smtp.wait_on_quit` (<>);;
If set to false the QUIT command is sent and the connection closed. If set to
true, the QUIT command is sent and a reply is waited for. True by default.
--
`xpack.notification.email.html.sanitization.allow`::
Specifies the HTML elements that are allowed in email notifications. For
more information, see
<>. You can
specify individual HTML elements and the following HTML feature groups:
+
--
[[html-feature-groups]]
`_tables`;;
All table related elements: `