- Elasticsearch Guide: other versions:
- Getting Started
- Set up Elasticsearch
- Installing Elasticsearch
- Configuring Elasticsearch
- Important Elasticsearch configuration
- Secure Settings
- Bootstrap Checks
- Heap size check
- File descriptor check
- Memory lock check
- Maximum number of threads check
- Max file size check
- Maximum size virtual memory check
- Maximum map count check
- Client JVM check
- Use serial collector check
- System call filter check
- OnError and OnOutOfMemoryError checks
- Early-access check
- G1GC check
- Important System Configuration
- Upgrading Elasticsearch
- Stopping Elasticsearch
- Set up X-Pack
- Breaking changes
- Breaking changes in 5.6
- Breaking changes in 5.5
- Breaking changes in 5.4
- Breaking changes in 5.3
- Breaking changes in 5.2
- Breaking changes in 5.1
- Breaking changes in 5.0
- Search and Query DSL changes
- Mapping changes
- Percolator changes
- Suggester changes
- Index APIs changes
- Document API changes
- Settings changes
- Allocation changes
- HTTP changes
- REST API changes
- CAT API changes
- Java API changes
- Packaging
- Plugin changes
- Filesystem related changes
- Path to data on disk
- Aggregation changes
- Script related changes
- API Conventions
- Document APIs
- Search APIs
- Aggregations
- Metrics Aggregations
- Avg Aggregation
- Cardinality Aggregation
- Extended Stats Aggregation
- Geo Bounds Aggregation
- Geo Centroid Aggregation
- Max Aggregation
- Min Aggregation
- Percentiles Aggregation
- Percentile Ranks Aggregation
- Scripted Metric Aggregation
- Stats Aggregation
- Sum Aggregation
- Top hits Aggregation
- Value Count Aggregation
- Bucket Aggregations
- Adjacency Matrix Aggregation
- Children Aggregation
- Date Histogram Aggregation
- Date Range Aggregation
- Diversified Sampler Aggregation
- Filter Aggregation
- Filters Aggregation
- Geo Distance Aggregation
- GeoHash grid Aggregation
- Global Aggregation
- Histogram Aggregation
- IP Range Aggregation
- Missing Aggregation
- Nested Aggregation
- Range Aggregation
- Reverse nested Aggregation
- Sampler Aggregation
- Significant Terms Aggregation
- Terms Aggregation
- Pipeline Aggregations
- Avg Bucket Aggregation
- Derivative Aggregation
- Max Bucket Aggregation
- Min Bucket Aggregation
- Sum Bucket Aggregation
- Stats Bucket Aggregation
- Extended Stats Bucket Aggregation
- Percentiles Bucket Aggregation
- Moving Average Aggregation
- Cumulative Sum Aggregation
- Bucket Script Aggregation
- Bucket Selector Aggregation
- Serial Differencing Aggregation
- Matrix Aggregations
- Caching heavy aggregations
- Returning only aggregation results
- Aggregation Metadata
- Returning the type of the aggregation
- Metrics Aggregations
- Indices APIs
- Create Index
- Delete Index
- Get Index
- Indices Exists
- Open / Close Index API
- Shrink Index
- Rollover Index
- Put Mapping
- Get Mapping
- Get Field Mapping
- Types Exists
- Index Aliases
- Update Indices Settings
- Get Settings
- Analyze
- Index Templates
- Shadow replica indices
- Indices Stats
- Indices Segments
- Indices Recovery
- Indices Shard Stores
- Clear Cache
- Flush
- Refresh
- Force Merge
- cat APIs
- Cluster APIs
- Query DSL
- Mapping
- Analysis
- Anatomy of an analyzer
- Testing analyzers
- Analyzers
- Normalizers
- Tokenizers
- Token Filters
- Standard Token Filter
- ASCII Folding Token Filter
- Flatten Graph Token Filter
- Length Token Filter
- Lowercase Token Filter
- Uppercase Token Filter
- NGram Token Filter
- Edge NGram Token Filter
- Porter Stem Token Filter
- Shingle Token Filter
- Stop Token Filter
- Word Delimiter Token Filter
- Word Delimiter Graph Token Filter
- Stemmer Token Filter
- Stemmer Override Token Filter
- Keyword Marker Token Filter
- Keyword Repeat Token Filter
- KStem Token Filter
- Snowball Token Filter
- Phonetic Token Filter
- Synonym Token Filter
- Synonym Graph Token Filter
- Compound Word Token Filters
- Reverse Token Filter
- Elision Token Filter
- Truncate Token Filter
- Unique Token Filter
- Pattern Capture Token Filter
- Pattern Replace Token Filter
- Trim Token Filter
- Limit Token Count Token Filter
- Hunspell Token Filter
- Common Grams Token Filter
- Normalization Token Filter
- CJK Width Token Filter
- CJK Bigram Token Filter
- Delimited Payload Token Filter
- Keep Words Token Filter
- Keep Types Token Filter
- Classic Token Filter
- Apostrophe Token Filter
- Decimal Digit Token Filter
- Fingerprint Token Filter
- Minhash Token Filter
- Character Filters
- Modules
- Index Modules
- Ingest Node
- Pipeline Definition
- Ingest APIs
- Accessing Data in Pipelines
- Handling Failures in Pipelines
- Processors
- Append Processor
- Convert Processor
- Date Processor
- Date Index Name Processor
- Fail Processor
- Foreach Processor
- Grok Processor
- Gsub Processor
- Join Processor
- JSON Processor
- KV Processor
- Lowercase Processor
- Remove Processor
- Rename Processor
- Script Processor
- Set Processor
- Split Processor
- Sort Processor
- Trim Processor
- Uppercase Processor
- Dot Expander Processor
- X-Pack APIs
- Info API
- Explore API
- Machine Learning APIs
- Close Jobs
- Create Datafeeds
- Create Jobs
- Delete Datafeeds
- Delete Jobs
- Delete Model Snapshots
- Flush Jobs
- Get Buckets
- Get Categories
- Get Datafeeds
- Get Datafeed Statistics
- Get Influencers
- Get Jobs
- Get Job Statistics
- Get Model Snapshots
- Get Records
- Open Jobs
- Post Data to Jobs
- Preview Datafeeds
- Revert Model Snapshots
- Start Datafeeds
- Stop Datafeeds
- Update Datafeeds
- Update Jobs
- Update Model Snapshots
- Security APIs
- Watcher APIs
- Migration APIs
- Deprecation Info APIs
- Definitions
- X-Pack Commands
- How To
- Testing
- Glossary of terms
- Release Notes
- 5.6.16 Release Notes
- 5.6.15 Release Notes
- 5.6.14 Release Notes
- 5.6.13 Release Notes
- 5.6.12 Release Notes
- 5.6.11 Release Notes
- 5.6.10 Release Notes
- 5.6.9 Release Notes
- 5.6.8 Release Notes
- 5.6.7 Release Notes
- 5.6.6 Release Notes
- 5.6.5 Release Notes
- 5.6.4 Release Notes
- 5.6.3 Release Notes
- 5.6.2 Release Notes
- 5.6.1 Release Notes
- 5.6.0 Release Notes
- 5.5.3 Release Notes
- 5.5.2 Release Notes
- 5.5.1 Release Notes
- 5.5.0 Release Notes
- 5.4.3 Release Notes
- 5.4.2 Release Notes
- 5.4.1 Release Notes
- 5.4.0 Release Notes
- 5.3.3 Release Notes
- 5.3.2 Release Notes
- 5.3.1 Release Notes
- 5.3.0 Release Notes
- 5.2.2 Release Notes
- 5.2.1 Release Notes
- 5.2.0 Release Notes
- 5.1.2 Release Notes
- 5.1.1 Release Notes
- 5.1.0 Release Notes
- 5.0.2 Release Notes
- 5.0.1 Release Notes
- 5.0.0 Combined Release Notes
- 5.0.0 GA Release Notes
- 5.0.0-rc1 Release Notes
- 5.0.0-beta1 Release Notes
- 5.0.0-alpha5 Release Notes
- 5.0.0-alpha4 Release Notes
- 5.0.0-alpha3 Release Notes
- 5.0.0-alpha2 Release Notes
- 5.0.0-alpha1 Release Notes
- 5.0.0-alpha1 Release Notes (Changes previously released in 2.x)
WARNING: Version 5.6 of Elasticsearch has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
You configure xpack.notification
settings in elasticsearch.yml
to
send set up Watcher and send notifications via email,
HipChat, Slack, and PagerDuty.
-
xpack.watcher.enabled
-
Set to
false
to disable Watcher on the node. -
xpack.watcher.history.cleaner_service.enabled
-
Set to
false
(default) to disable the cleaner service. If this setting istrue
, thexpack.monitoring.enabled
setting must also be set totrue
. 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 thexpack.monitoring.history.duration
setting, which defaults to 7 days. For more information about that setting, see Monitoring Settings. [5.6.4] Added in 5.6.4. -
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.
You can configure the following TLS/SSL settings. If the settings are not configured, the Default TLS/SSL Settings are used.
-
xpack.http.ssl.supported_protocols
-
Supported protocols with versions. Valid protocols:
SSLv2Hello
,SSLv3
,TLSv1
,TLSv1.1
,TLSv1.2
. Defaults toTLSv1.2
,TLSv1.1
,TLSv1
. Defaults to the value ofxpack.ssl.supported_protocols
. -
xpack.http.ssl.verification_mode
-
Controls the verification of certificates. Valid values are
none
,certificate
, andfull
. Defaults to the value ofxpack.ssl.verification_mode
. -
xpack.http.ssl.cipher_suites
-
Supported cipher suites can be found in Oracle’s
Java Cryptography Architecture documentation. Defaults to the value of
xpack.ssl.cipher_suites
.
The following settings are used to specify a private key, certificate, and the trusted certificates that should be used when communicating over an SSL/TLS connection. If none of the settings below are specified, the Default TLS/SSL Settings are used. A private key and certificate are optional and would be used if the server requires client authentication for PKI authentication. If none of the settings below are specified, the Default TLS/SSL Settings are used.
When using PEM encoded files, use the following settings:
-
xpack.http.ssl.key
- Path to a PEM encoded file containing the private key.
-
xpack.http.ssl.key_passphrase
- The passphrase that is used to decrypt the private key. This value is optional as the key might not be encrypted.
-
xpack.http.ssl.secure_key_passphrase
(Secure) - The passphrase that is used to decrypt the private key. This value is optional as the key might not be encrypted.
-
xpack.http.ssl.certificate
- Path to a PEM encoded file containing the certificate (or certificate chain) that will be presented when requested.
-
xpack.http.ssl.certificate_authorities
- List of paths to the PEM encoded certificate files that should be trusted.
When using Java keystore files (JKS), which contain the private key, certificate and certificates that should be trusted, use the following settings:
-
xpack.http.ssl.keystore.path
- Path to the keystore that holds the private key and certificate.
-
xpack.http.ssl.keystore.password
- Password to the keystore.
- +xpack.http.ssl.keystore.secure_password` (Secure)
- Password to the keystore.
-
xpack.http.ssl.keystore.key_password
-
Password for the private key in the keystore. Defaults to the
same value as
xpack.http.ssl.keystore.password
. -
xpack.http.ssl.keystore.secure_key_password
(Secure) - Password for the private key in the keystore.
-
xpack.http.ssl.truststore.path
- Path to the truststore file.
-
xpack.http.ssl.truststore.password
- Password to the truststore.
-
xpack.http.ssl.truststore.secure_password
(Secure) - Password to the truststore.
You can configure the following email notification settings in
elasticsearch.yml
. For more information about sending notifications
via email, see Configuring Email.
-
xpack.notification.email.account
-
Specifies account information for sending notifications via email. You can specify the following email account attributes:
+
profile
;; The email profile to use to build the MIME messages that are sent from the account. Valid values:standard
,gmail
andoutlook
. Defaults tostandard
.-
email_defaults.*
- An optional set of email attributes to use as defaults for the emails sent from the account. See Email Action Attributes for the supported attributes.
-
smtp.auth
-
Set to
true
to attempt to authenticate the user using the AUTH command. Defaults tofalse
. -
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.password
- The password for the specified SMTP user.
-
smtp.starttls.enable
-
Set to
true
to enable the use of theSTARTTLS
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 configured so that the client will trust the server’s certificate. Defaults tofalse
. -
smtp.*
-
SMTP attributes that enable fine control over the SMTP
protocol when sending messages. See
com.sun.mail.smtp
for the full list of SMTP properties you can set. Note that all timeouts
(
writetimeout
,connection_timeout
andtimeout
) default to 2 minutes.
-
-
xpack.notification.email.html.sanitization.allow
- Specifies the HTML elements that are allowed in email notifications. For more information, see Configuring HTML Sanitization Options. You can specify individual HTML elements and the following HTML feature groups:
-
_tables
-
All table related elements:
<table>
,<th>
,<tr>
and<td>
. -
_blocks
-
The following block elements:
<p>
,<div>
,<h1>
,<h2>
,<h3>
,<h4>
,<h5>
,<h6>
,<ul>
,<ol>
,<li>
, and<blockquote>
. -
_formatting
-
The following inline formatting elements:
<b>
,<i>
,<s>
,<u>
,<o>
,<sup>
,<sub>
,<ins>
,<del>
,<strong>
,<strike>
,<tt>
,<code>
,<big>
,<small>
,<br>
,<span>
, and<em>
. -
_links
-
The
<a>
element with anhref
attribute that points to a URL using the following protocols:http
,https
andmailto
. -
_styles
-
The
style
attribute on all elements. Note that CSS attributes are also sanitized to prevent XSS attacks. -
img
-
img:all
- All images (external and embedded).
-
img:embedded
-
Only embedded images. Embedded images can only use the
cid:
URL protocol in theirsrc
attribute.
-
xpack.notification.email.html.sanitization.disallow
- Specifies the HTML elements that are NOT allowed in email notifications. You can specify individual HTML elements and HTML feature groups.
-
xpack.notification.email.html.sanitization.enabled
-
Set to
false
to completely disable HTML sanitation. Not recommended. Defaults totrue
.
You can configure the following HipChat notification settings in
elasticsearch.yml
. For more information about sending notifications
via HipChat, see
Configuring HipChat.
-
xpack.notification.hipchat
-
Specifies account information for sending notifications via HipChat. You can specify the following HipChat account attributes:
-
profile
-
The HipChat account profile to use:
integration
,user
, orv1
. Required. -
auth_token
- The authentication token to use to access the HipChat API. Required.
-
host
-
The HipChat server hostname. Defaults to
api.hipchat.com
. -
port
- The HipChat server port number. Defaults to 443.
-
room
-
The room you want to send messages to. Must be specified
if the
profile
is set tointegration
. Not valid for theuser
orvi
profiles. -
user
-
The HipChat user account to use to send messages.
Specified as an email address. Must be specified if the
profile
is set touser
. Not valid for theintegration
orv1
profiles. -
message.format
-
The format of the message:
text
orhtml
. Defaults tohtml
. -
message.color
-
The background color of the notification in the room.
Defaults to
yellow
. -
message.notify
-
Indicates whether people in the room should be
actively notified. Defaults to
false
.
-
You can configure the following Slack notification settings in
elasticsearch.yml
. For more information about sending notifications
via Slack, see Configuring Slack.
-
xpack.notification.slack
-
Specifies account information for sending notifications via Slack. You can specify the following Slack account attributes:
-
url
- The Incoming Webhook URL to use to post messages to Slack. Required.
-
message_defaults.from
- The sender name to display in the Slack message. Defaults to the watch ID.
-
message_defaults.to
- The default Slack channels or groups you want to send messages to.
-
message_defaults.icon
- The icon to display in the Slack messages. Overrides the incoming webhook’s configured icon. Accepts a public URL to an image.
-
message_defaults.text
- The default message content.
-
message_defaults.attachment
- Default message attachments. Slack message attachments enable you to create more richly-formatted messages. Specified as an array as defined in the Slack attachments documentation.
-
You can configure the following Jira notification settings in
elasticsearch.yml
. For more information about using notifications
to create issues in Jira, see Configuring Jira.
-
xpack.notification.jira
- Specifies account information for using notifications to create issues in Jira. You can specify the following Jira account attributes:
-
url
- The URL of the Jira Software server. Required.
-
user
- The name of the user to connect to the Jira Software server. Required.
-
password
- The password of the user to connect to the Jira Software server. Required.
-
issue_defaults
- Default fields values for the issue created in Jira. See Jira Action Attributes for more information. Optional.
You can configure the following PagerDuty notification settings in
elasticsearch.yml
. For more information about sending notifications
via PagerDuty, see
Configuring PagerDuty.
-
xpack.notification.pagerduty
-
Specifies account information for sending notifications via PagerDuty. You can specify the following PagerDuty account attributes:
-
name
- A name for the PagerDuty account associated with the API key you are using to access PagerDuty. Required.
-
service_api_key
- The PagerDuty API key to use to access PagerDuty. Required.
-
event_defaults
-
Default values for PagerDuty event attributes. Optional.
-
description
-
A string that contains the default description for PagerDuty events.
If no default is configured, each PagerDuty action must specify a
description
. -
incident_key
- A string that contains the default incident key to use when sending PagerDuty events.
-
client
- A string that specifies the default monitoring client.
-
client_url
- The URL of the default monitoring client.
-
event_type
-
The default event type. Valid values:
trigger
,resolve
,acknowledge
. -
attach_payload
-
Whether or not to provide the watch payload as context for
the event by default. Valid values:
true
,false
.
-
-
On this page