- Elasticsearch Guide: other versions:
- What is Elasticsearch?
- What’s new in 8.11
- Quick start
- Set up Elasticsearch
- Installing Elasticsearch
- Run Elasticsearch locally
- Configuring Elasticsearch
- Important Elasticsearch configuration
- Secure settings
- Auditing settings
- Circuit breaker settings
- Cluster-level shard allocation and routing settings
- Miscellaneous cluster settings
- Cross-cluster replication settings
- Discovery and cluster formation settings
- Field data cache settings
- Health Diagnostic settings
- Index lifecycle management settings
- Data stream lifecycle settings
- Index management settings
- Index recovery settings
- Indexing buffer settings
- License settings
- Local gateway settings
- Logging
- Machine learning settings
- Monitoring settings
- Node
- Networking
- Node query cache settings
- Search settings
- Security settings
- Shard request cache settings
- Snapshot and restore settings
- Transforms settings
- Thread pools
- Watcher settings
- Advanced configuration
- Important system configuration
- 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
- All permission check
- Discovery configuration check
- Bootstrap Checks for X-Pack
- Starting Elasticsearch
- Stopping Elasticsearch
- Discovery and cluster formation
- Add and remove nodes in your cluster
- Full-cluster restart and rolling restart
- Remote clusters
- Plugins
- Upgrade Elasticsearch
- Index modules
- Mapping
- Text analysis
- Overview
- Concepts
- Configure text analysis
- Built-in analyzer reference
- Tokenizer reference
- Token filter reference
- Apostrophe
- ASCII folding
- CJK bigram
- CJK width
- Classic
- Common grams
- Conditional
- Decimal digit
- Delimited payload
- Dictionary decompounder
- Edge n-gram
- Elision
- Fingerprint
- Flatten graph
- Hunspell
- Hyphenation decompounder
- Keep types
- Keep words
- Keyword marker
- Keyword repeat
- KStem
- Length
- Limit token count
- Lowercase
- MinHash
- Multiplexer
- N-gram
- Normalization
- Pattern capture
- Pattern replace
- Phonetic
- Porter stem
- Predicate script
- Remove duplicates
- Reverse
- Shingle
- Snowball
- Stemmer
- Stemmer override
- Stop
- Synonym
- Synonym graph
- Trim
- Truncate
- Unique
- Uppercase
- Word delimiter
- Word delimiter graph
- Character filters reference
- Normalizers
- Index templates
- Data streams
- Ingest pipelines
- Example: Parse logs
- Enrich your data
- Processor reference
- Append
- Attachment
- Bytes
- Circle
- Community ID
- Convert
- CSV
- Date
- Date index name
- Dissect
- Dot expander
- Drop
- Enrich
- Fail
- Fingerprint
- Foreach
- Geo-grid
- GeoIP
- Grok
- Gsub
- HTML strip
- Inference
- Join
- JSON
- KV
- Lowercase
- Network direction
- Pipeline
- Redact
- Registered domain
- Remove
- Rename
- Reroute
- Script
- Set
- Set security user
- Sort
- Split
- Trim
- Uppercase
- URL decode
- URI parts
- User agent
- Ingest pipelines in Search
- Aliases
- Search your data
- Query DSL
- Aggregations
- Bucket aggregations
- Adjacency matrix
- Auto-interval date histogram
- Categorize text
- Children
- Composite
- Date histogram
- Date range
- Diversified sampler
- Filter
- Filters
- Frequent item sets
- Geo-distance
- Geohash grid
- Geohex grid
- Geotile grid
- Global
- Histogram
- IP prefix
- IP range
- Missing
- Multi Terms
- Nested
- Parent
- Random sampler
- Range
- Rare terms
- Reverse nested
- Sampler
- Significant terms
- Significant text
- Terms
- Time series
- Variable width histogram
- Subtleties of bucketing range fields
- Metrics aggregations
- Pipeline aggregations
- Average bucket
- Bucket script
- Bucket count K-S test
- Bucket correlation
- Bucket selector
- Bucket sort
- Change point
- Cumulative cardinality
- Cumulative sum
- Derivative
- Extended stats bucket
- Inference bucket
- Max bucket
- Min bucket
- Moving function
- Moving percentiles
- Normalize
- Percentiles bucket
- Serial differencing
- Stats bucket
- Sum bucket
- Bucket aggregations
- Geospatial analysis
- EQL
- ES|QL
- SQL
- Overview
- Getting Started with SQL
- Conventions and Terminology
- Security
- SQL REST API
- SQL Translate API
- SQL CLI
- SQL JDBC
- SQL ODBC
- SQL Client Applications
- SQL Language
- Functions and Operators
- Comparison Operators
- Logical Operators
- Math Operators
- Cast Operators
- LIKE and RLIKE Operators
- Aggregate Functions
- Grouping Functions
- Date/Time and Interval Functions and Operators
- Full-Text Search Functions
- Mathematical Functions
- String Functions
- Type Conversion Functions
- Geo Functions
- Conditional Functions And Expressions
- System Functions
- Reserved keywords
- SQL Limitations
- Scripting
- Data management
- ILM: Manage the index lifecycle
- Tutorial: Customize built-in policies
- Tutorial: Automate rollover
- Index management in Kibana
- Overview
- Concepts
- Index lifecycle actions
- Configure a lifecycle policy
- Migrate index allocation filters to node roles
- Troubleshooting index lifecycle management errors
- Start and stop index lifecycle management
- Manage existing indices
- Skip rollover
- Restore a managed data stream or index
- Data tiers
- Autoscaling
- Monitor a cluster
- Roll up or transform your data
- Set up a cluster for high availability
- Snapshot and restore
- Secure the Elastic Stack
- Elasticsearch security principles
- Start the Elastic Stack with security enabled automatically
- Manually configure security
- Updating node security certificates
- User authentication
- Built-in users
- Service accounts
- Internal users
- Token-based authentication services
- User profiles
- Realms
- Realm chains
- Security domains
- Active Directory user authentication
- File-based user authentication
- LDAP user authentication
- Native user authentication
- OpenID Connect authentication
- PKI user authentication
- SAML authentication
- Kerberos authentication
- JWT authentication
- Integrating with other authentication systems
- Enabling anonymous access
- Looking up users without authentication
- Controlling the user cache
- Configuring SAML single-sign-on on the Elastic Stack
- Configuring single sign-on to the Elastic Stack using OpenID Connect
- User authorization
- Built-in roles
- Defining roles
- Role restriction
- Security privileges
- Document level security
- Field level security
- Granting privileges for data streams and aliases
- Mapping users and groups to roles
- Setting up field and document level security
- Submitting requests on behalf of other users
- Configuring authorization delegation
- Customizing roles and authorization
- Enable audit logging
- Restricting connections with IP filtering
- Securing clients and integrations
- Operator privileges
- Troubleshooting
- Some settings are not returned via the nodes settings API
- Authorization exceptions
- Users command fails due to extra arguments
- Users are frequently locked out of Active Directory
- Certificate verification fails for curl on Mac
- SSLHandshakeException causes connections to fail
- Common SSL/TLS exceptions
- Common Kerberos exceptions
- Common SAML issues
- Internal Server Error in Kibana
- Setup-passwords command fails due to connection failure
- Failures due to relocation of the configuration files
- Limitations
- Watcher
- Command line tools
- elasticsearch-certgen
- elasticsearch-certutil
- elasticsearch-create-enrollment-token
- elasticsearch-croneval
- elasticsearch-keystore
- elasticsearch-node
- elasticsearch-reconfigure-node
- elasticsearch-reset-password
- elasticsearch-saml-metadata
- elasticsearch-service-tokens
- elasticsearch-setup-passwords
- elasticsearch-shard
- elasticsearch-syskeygen
- elasticsearch-users
- How to
- Troubleshooting
- Fix common cluster issues
- Diagnose unassigned shards
- Add a missing tier to the system
- Allow Elasticsearch to allocate the data in the system
- Allow Elasticsearch to allocate the index
- Indices mix index allocation filters with data tiers node roles to move through data tiers
- Not enough nodes to allocate all shard replicas
- Total number of shards for an index on a single node exceeded
- Total number of shards per node has been reached
- Troubleshooting corruption
- Fix data nodes out of disk
- Fix master nodes out of disk
- Fix other role nodes out of disk
- Start index lifecycle management
- Start Snapshot Lifecycle Management
- Restore from snapshot
- Multiple deployments writing to the same snapshot repository
- Addressing repeated snapshot policy failures
- Troubleshooting an unstable cluster
- Troubleshooting discovery
- Troubleshooting monitoring
- Troubleshooting transforms
- Troubleshooting Watcher
- Troubleshooting searches
- Troubleshooting shards capacity health issues
- REST APIs
- API conventions
- Common options
- REST API compatibility
- Autoscaling APIs
- Behavioral Analytics APIs
- Compact and aligned text (CAT) APIs
- cat aliases
- cat allocation
- cat anomaly detectors
- cat component templates
- cat count
- cat data frame analytics
- cat datafeeds
- cat fielddata
- cat health
- cat indices
- cat master
- cat nodeattrs
- cat nodes
- cat pending tasks
- cat plugins
- cat recovery
- cat repositories
- cat segments
- cat shards
- cat snapshots
- cat task management
- cat templates
- cat thread pool
- cat trained model
- cat transforms
- Cluster APIs
- Cluster allocation explain
- Cluster get settings
- Cluster health
- Health
- Cluster reroute
- Cluster state
- Cluster stats
- Cluster update settings
- Nodes feature usage
- Nodes hot threads
- Nodes info
- Prevalidate node removal
- Nodes reload secure settings
- Nodes stats
- Cluster Info
- Pending cluster tasks
- Remote cluster info
- Task management
- Voting configuration exclusions
- Create or update desired nodes
- Get desired nodes
- Delete desired nodes
- Get desired balance
- Reset desired balance
- Cross-cluster replication APIs
- Data stream APIs
- Document APIs
- Enrich APIs
- EQL APIs
- ES|QL query API
- Features APIs
- Fleet APIs
- Find structure API
- Graph explore API
- Index APIs
- Alias exists
- Aliases
- Analyze
- Analyze index disk usage
- Clear cache
- Clone index
- Close index
- Create index
- Create or update alias
- Create or update component template
- Create or update index template
- Create or update index template (legacy)
- Delete component template
- Delete dangling index
- Delete alias
- Delete index
- Delete index template
- Delete index template (legacy)
- Exists
- Field usage stats
- Flush
- Force merge
- Get alias
- Get component template
- Get field mapping
- Get index
- Get index settings
- Get index template
- Get index template (legacy)
- Get mapping
- Import dangling index
- Index recovery
- Index segments
- Index shard stores
- Index stats
- Index template exists (legacy)
- List dangling indices
- Open index
- Refresh
- Resolve index
- Rollover
- Shrink index
- Simulate index
- Simulate template
- Split index
- Unfreeze index
- Update index settings
- Update mapping
- Index lifecycle management APIs
- Create or update lifecycle policy
- Get policy
- Delete policy
- Move to step
- Remove policy
- Retry policy
- Get index lifecycle management status
- Explain lifecycle
- Start index lifecycle management
- Stop index lifecycle management
- Migrate indices, ILM policies, and legacy, composable and component templates to data tiers routing
- Inference APIs
- Info API
- Ingest APIs
- Licensing APIs
- Logstash APIs
- Machine learning APIs
- Machine learning anomaly detection APIs
- Add events to calendar
- Add jobs to calendar
- Close jobs
- Create jobs
- Create calendars
- Create datafeeds
- Create filters
- Delete calendars
- Delete datafeeds
- Delete events from calendar
- Delete filters
- Delete forecasts
- Delete jobs
- Delete jobs from calendar
- Delete model snapshots
- Delete expired data
- Estimate model memory
- Flush jobs
- Forecast jobs
- Get buckets
- Get calendars
- Get categories
- Get datafeeds
- Get datafeed statistics
- Get influencers
- Get jobs
- Get job statistics
- Get model snapshots
- Get model snapshot upgrade statistics
- Get overall buckets
- Get scheduled events
- Get filters
- Get records
- Open jobs
- Post data to jobs
- Preview datafeeds
- Reset jobs
- Revert model snapshots
- Start datafeeds
- Stop datafeeds
- Update datafeeds
- Update filters
- Update jobs
- Update model snapshots
- Upgrade model snapshots
- Machine learning data frame analytics APIs
- Create data frame analytics jobs
- Delete data frame analytics jobs
- Evaluate data frame analytics
- Explain data frame analytics
- Get data frame analytics jobs
- Get data frame analytics jobs stats
- Preview data frame analytics
- Start data frame analytics jobs
- Stop data frame analytics jobs
- Update data frame analytics jobs
- Machine learning trained model APIs
- Clear trained model deployment cache
- Create or update trained model aliases
- Create part of a trained model
- Create trained models
- Create trained model vocabulary
- Delete trained model aliases
- Delete trained models
- Get trained models
- Get trained models stats
- Infer trained model
- Start trained model deployment
- Stop trained model deployment
- Update trained model deployment
- Migration APIs
- Node lifecycle APIs
- Query rules APIs
- Reload search analyzers API
- Repositories metering APIs
- Rollup APIs
- Script APIs
- Search APIs
- Search Application APIs
- Searchable snapshots APIs
- Security APIs
- Authenticate
- Change passwords
- Clear cache
- Clear roles cache
- Clear privileges cache
- Clear API key cache
- Clear service account token caches
- Create API keys
- Create or update application privileges
- Create or update role mappings
- Create or update roles
- Create or update users
- Create service account tokens
- Delegate PKI authentication
- Delete application privileges
- Delete role mappings
- Delete roles
- Delete service account token
- Delete users
- Disable users
- Enable users
- Enroll Kibana
- Enroll node
- Get API key information
- Get application privileges
- Get builtin privileges
- Get role mappings
- Get roles
- Get service accounts
- Get service account credentials
- Get token
- Get user privileges
- Get users
- Grant API keys
- Has privileges
- Invalidate API key
- Invalidate token
- OpenID Connect prepare authentication
- OpenID Connect authenticate
- OpenID Connect logout
- Query API key information
- Update API key
- Bulk update API keys
- SAML prepare authentication
- SAML authenticate
- SAML logout
- SAML invalidate
- SAML complete logout
- SAML service provider metadata
- SSL certificate
- Activate user profile
- Disable user profile
- Enable user profile
- Get user profiles
- Suggest user profile
- Update user profile data
- Has privileges user profile
- Create Cross-Cluster API key
- Update Cross-Cluster API key
- Snapshot and restore APIs
- Snapshot lifecycle management APIs
- SQL APIs
- Synonyms APIs
- Transform APIs
- Usage API
- Watcher APIs
- Definitions
- Migration guide
- Release notes
- Elasticsearch version 8.11.4
- Elasticsearch version 8.11.3
- Elasticsearch version 8.11.2
- Elasticsearch version 8.11.1
- Elasticsearch version 8.11.0
- Elasticsearch version 8.10.4
- Elasticsearch version 8.10.3
- Elasticsearch version 8.10.2
- Elasticsearch version 8.10.1
- Elasticsearch version 8.10.0
- Elasticsearch version 8.9.2
- Elasticsearch version 8.9.1
- Elasticsearch version 8.9.0
- Elasticsearch version 8.8.2
- Elasticsearch version 8.8.1
- Elasticsearch version 8.8.0
- Elasticsearch version 8.7.1
- Elasticsearch version 8.7.0
- Elasticsearch version 8.6.2
- Elasticsearch version 8.6.1
- Elasticsearch version 8.6.0
- Elasticsearch version 8.5.3
- Elasticsearch version 8.5.2
- Elasticsearch version 8.5.1
- Elasticsearch version 8.5.0
- Elasticsearch version 8.4.3
- Elasticsearch version 8.4.2
- Elasticsearch version 8.4.1
- Elasticsearch version 8.4.0
- Elasticsearch version 8.3.3
- Elasticsearch version 8.3.2
- Elasticsearch version 8.3.1
- Elasticsearch version 8.3.0
- Elasticsearch version 8.2.3
- Elasticsearch version 8.2.2
- Elasticsearch version 8.2.1
- Elasticsearch version 8.2.0
- Elasticsearch version 8.1.3
- Elasticsearch version 8.1.2
- Elasticsearch version 8.1.1
- Elasticsearch version 8.1.0
- Elasticsearch version 8.0.1
- Elasticsearch version 8.0.0
- Elasticsearch version 8.0.0-rc2
- Elasticsearch version 8.0.0-rc1
- Elasticsearch version 8.0.0-beta1
- Elasticsearch version 8.0.0-alpha2
- Elasticsearch version 8.0.0-alpha1
- Dependencies and versions
Watcher settings in Elasticsearch
editWatcher settings in Elasticsearch
editYou configure Watcher settings to set up Watcher and send notifications via email, Slack, and PagerDuty.
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 Elasticsearch keystore.
For more information about creating and updating the Elasticsearch keystore, see
Secure settings. Dynamic settings can also be updated across a cluster with the
cluster update settings API.
General Watcher Settings
edit-
xpack.watcher.enabled
-
(Static)
Set to
false
to disable Watcher on the node.
-
xpack.watcher.encrypt_sensitive_data
-
(Static)
Set to
true
to encrypt sensitive data. If this setting is enabled, you must also specify thexpack.watcher.encryption_key
setting. For more information, see Encrypting sensitive data in Watcher. -
xpack.watcher.encryption_key
-
(Secure)
Specifies the path to a file that contains a key for encrypting sensitive data.
If
xpack.watcher.encrypt_sensitive_data
is set totrue
, this setting is required. For more information, see Encrypting sensitive data in Watcher. -
xpack.http.proxy.host
- (Static) Specifies the address of the proxy server to use to connect to HTTP services.
-
xpack.http.proxy.port
- (Static) Specifies the port number to use to connect to the proxy server.
-
xpack.http.proxy.scheme
-
(Static)
Protocol used to communicate with the proxy server. Valid values are
http
andhttps
. Defaults to the protocol used in the request. -
xpack.http.default_connection_timeout
- (Static) The maximum period to wait until abortion of the request, when a connection is being initiated.
-
xpack.http.default_read_timeout
- (Static) The maximum period of inactivity between two data packets, before the request is aborted.
-
xpack.http.tcp.keep_alive
-
(Static)
Whether to enable TCP keepalives on HTTP connections. Defaults to
true
. -
xpack.http.connection_pool_ttl
- (Static) The time-to-live of connections in the connection pool. If a connection is not re-used within this timeout, it is closed. By default, the time-to-live is infinite meaning that connections never expire.
-
xpack.http.max_response_size
-
(Static)
Specifies the maximum size an HTTP response is allowed to have, defaults to
10mb
, the maximum configurable value is50mb
. -
xpack.http.whitelist
-
(Dynamic)
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.
Watcher HTTP TLS/SSL settings
editYou can configure the following TLS/SSL settings.
-
xpack.http.ssl.supported_protocols
-
(Static) Supported protocols with versions. Valid protocols:
SSLv2Hello
,SSLv3
,TLSv1
,TLSv1.1
,TLSv1.2
,TLSv1.3
. If the JVM’s SSL provider supports TLSv1.3, the default isTLSv1.3,TLSv1.2,TLSv1.1
. Otherwise, the default isTLSv1.2,TLSv1.1
.Elasticsearch relies on your JDK’s implementation of SSL and TLS. View Supported SSL/TLS versions by JDK version for more information.
If
xpack.security.fips_mode.enabled
istrue
, you cannot useSSLv2Hello
orSSLv3
. See FIPS 140-2. -
xpack.http.ssl.verification_mode
-
(Static) Defines how to verify the certificates presented by another party in the TLS connection:
Valid values
-
full
-
Validates that the provided certificate: has an issue date that’s
within the
not_before
andnot_after
dates; chains to a trusted Certificate Authority (CA); has ahostname
or IP address that matches the names within the certificate. -
certificate
-
Validates the provided certificate and verifies that it’s signed by a
trusted authority (CA), but doesn’t check the certificate
hostname
. -
none
-
Performs no certificate validation.
Setting certificate validation to
none
disables many security benefits of SSL/TLS, which is very dangerous. Only set this value if instructed by Elastic Support as a temporary diagnostic mechanism when attempting to resolve TLS errors.
Defaults to
full
. -
-
xpack.http.ssl.cipher_suites
-
(Static) Supported cipher suites vary depending on which version of Java you use. For example, for version 12 the default value is
TLS_AES_256_GCM_SHA384
,TLS_AES_128_GCM_SHA256
,TLS_CHACHA20_POLY1305_SHA256
,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
,TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256
,TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
,TLS_RSA_WITH_AES_256_GCM_SHA384
,TLS_RSA_WITH_AES_128_GCM_SHA256
,TLS_RSA_WITH_AES_256_CBC_SHA256
,TLS_RSA_WITH_AES_128_CBC_SHA256
,TLS_RSA_WITH_AES_256_CBC_SHA
,TLS_RSA_WITH_AES_128_CBC_SHA
.For more information, see Oracle’s Java Cryptography Architecture documentation.
Watcher HTTP TLS/SSL key and trusted certificate settings
editThe 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. A private key and certificate are optional and would be used if the server requires client authentication for PKI authentication.
PEM encoded files
editWhen using PEM encoded files, use the following settings:
-
xpack.http.ssl.key
-
(Static) Path to a PEM encoded file containing the private key.
If HTTP client authentication is required, it uses this file. You cannot use this setting and
ssl.keystore.path
at the same time. -
xpack.http.ssl.secure_key_passphrase
- (Secure) The passphrase that is used to decrypt the private key. Since the key might not be encrypted, this value is optional.
-
xpack.http.ssl.certificate
-
(Static) Specifies the path for the PEM encoded certificate (or certificate chain) that is associated with the key.
This setting can be used only if
ssl.key
is set. -
xpack.http.ssl.certificate_authorities
-
(Static) List of paths to PEM encoded certificate files that should be trusted.
This setting and
ssl.truststore.path
cannot be used at the same time.
Java keystore files
editWhen 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
-
(Static) The path for the keystore file that contains a private key and certificate.
It must be either a Java keystore (jks) or a PKCS#12 file. You cannot use this setting and
ssl.key
at the same time. -
xpack.http.ssl.keystore.secure_password
- (Secure) The password for the keystore.
-
xpack.http.ssl.keystore.secure_key_password
- (Secure) The password for the key in the keystore. The default is the keystore password.
-
xpack.http.ssl.truststore.path
-
(Static) The path for the keystore that contains the certificates to trust. It must be either a Java keystore (jks) or a PKCS#12 file.
You cannot use this setting and
ssl.certificate_authorities
at the same time. -
xpack.http.ssl.truststore.secure_password
- (Secure) Password for the truststore.
PKCS#12 files
editElasticsearch can be configured to use PKCS#12 container files (.p12
or .pfx
files)
that contain the private key, certificate and certificates that should be trusted.
PKCS#12 files are configured in the same way as Java keystore files:
-
xpack.http.ssl.keystore.path
-
(Static) The path for the keystore file that contains a private key and certificate.
It must be either a Java keystore (jks) or a PKCS#12 file. You cannot use this setting and
ssl.key
at the same time. -
xpack.http.ssl.keystore.type
-
(Static)
The format of the keystore file. It must be either
jks
orPKCS12
. If the keystore path ends in ".p12", ".pfx", or ".pkcs12", this setting defaults toPKCS12
. Otherwise, it defaults tojks
. -
xpack.http.ssl.keystore.secure_password
- (Secure) The password for the keystore.
-
xpack.http.ssl.keystore.secure_key_password
- (Secure) The password for the key in the keystore. The default is the keystore password.
-
xpack.http.ssl.truststore.path
-
(Static) The path for the keystore that contains the certificates to trust. It must be either a Java keystore (jks) or a PKCS#12 file.
You cannot use this setting and
ssl.certificate_authorities
at the same time. -
xpack.http.ssl.truststore.type
-
(Static)
Set this to
PKCS12
to indicate that the truststore is a PKCS#12 file. -
xpack.http.ssl.truststore.secure_password
- (Secure) Password for the truststore.
Email Notification Settings
editYou can configure the following email notification settings in
elasticsearch.yml
. For more information about sending notifications
via email, see Configuring email actions.
-
xpack.notification.email.default_account
-
(Dynamic) Default email account to use.
If you configure multiple email accounts, you must either configure this setting or specify the email account to use in the
email
action. See Configuring email accounts. -
xpack.notification.email.account
- Specifies account information for sending notifications via email. You can specify the following email account attributes:
-
xpack.notification.email.account.domain_allowlist
-
(Dynamic)
Specifies domains to which emails are allowed to be sent. Emails with recipients (
To:
,Cc:
, orBcc:
) outside of these domains will be rejected and an error thrown. This setting defaults to["*"]
which means all domains are allowed. Simple globbing is supported, such as*.company.com
in the list of allowed domains.
-
profile
-
(Dynamic)
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.*
- (Dynamic) 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
-
(Dynamic)
Set to
true
to attempt to authenticate the user using the AUTH command. Defaults tofalse
. -
smtp.host
- (Dynamic) The SMTP server to connect to. Required.
-
smtp.port
- (Dynamic) The SMTP server port to connect to. Defaults to 25.
-
smtp.user
- (Dynamic) The user name for SMTP. Required.
-
smtp.secure_password
- (Secure, reloadable) The password for the specified SMTP user.
-
smtp.starttls.enable
-
(Dynamic)
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 be configured so that the client will trust the server’s certificate. Defaults tofalse
. -
smtp.starttls.required
-
(Dynamic)
If
true
, thenSTARTTLS
will be required. If that command fails, the connection will fail. Defaults tofalse
. -
smtp.ssl.trust
- (Dynamic) 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
- (Dynamic) The socket read timeout. Default is two minutes.
-
smtp.connection_timeout
- (Dynamic) The socket connection timeout. Default is two minutes.
-
smtp.write_timeout
- (Dynamic) The socket write timeout. Default is two minutes.
-
smtp.local_address
- (Dynamic) A configurable local address when sending emails. Not configured by default.
-
smtp.local_port
- (Dynamic) A configurable local port when sending emails. Not configured by default.
-
smtp.send_partial
- (Dynamic) Send an email, despite one of the receiver addresses being invalid.
-
smtp.wait_on_quit
- (Dynamic) 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 Configuring HTML sanitization options. You can specify individual HTML elements and the following HTML feature groups:
-
_tables
-
(Static)
All table related elements:
<table>
,<th>
,<tr>
,<td>
,<caption>
,<col>
,<colgroup>
,<thead>
,<tbody>
, and<tfoot>
. -
_blocks
-
(Static)
The following block elements:
<p>
,<div>
,<h1>
,<h2>
,<h3>
,<h4>
,<h5>
,<h6>
,<ul>
,<ol>
,<li>
, and<blockquote>
. -
_formatting
-
(Static)
The following inline formatting elements:
<b>
,<i>
,<s>
,<u>
,<o>
,<sup>
,<sub>
,<ins>
,<del>
,<strong>
,<strike>
,<tt>
,<code>
,<big>
,<small>
,<hr>
,<br>
,<span>
, and<em>
. -
_links
-
(Static)
The
<a>
element with anhref
attribute that points to a URL using the following protocols:http
,https
andmailto
. -
_styles
-
(Static)
The
style
attribute on all elements. Note that CSS attributes are also sanitized to prevent XSS attacks. -
img
-
img:all
- (Static) All images (external and embedded).
-
img:embedded
-
(Static)
Only embedded images. Embedded images can only use the
cid:
URL protocol in theirsrc
attribute.
-
-
xpack.notification.email.html.sanitization.disallow
- (Static) 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
-
(Static)
Set to
false
to completely disable HTML sanitation. Not recommended. Defaults totrue
. -
xpack.notification.reporting.warning.kbn-csv-contains-formulas.text
-
(Dynamic)
Specifies a custom message, which is sent if the formula verification criteria
for CSV files from Kibana’s
xpack.reporting.csv.checkForFormulas
istrue
. Use%s
in the message as a placeholder for the filename. Defaults toWarning: The attachment [%s] contains characters which spreadsheet applications may interpret as formulas. Please ensure that the attachment is safe prior to opening.
Watcher Email TLS/SSL settings
editYou can configure the following TLS/SSL settings.
-
xpack.notification.email.ssl.supported_protocols
-
(Static) Supported protocols with versions. Valid protocols:
SSLv2Hello
,SSLv3
,TLSv1
,TLSv1.1
,TLSv1.2
,TLSv1.3
. If the JVM’s SSL provider supports TLSv1.3, the default isTLSv1.3,TLSv1.2,TLSv1.1
. Otherwise, the default isTLSv1.2,TLSv1.1
.Elasticsearch relies on your JDK’s implementation of SSL and TLS. View Supported SSL/TLS versions by JDK version for more information.
If
xpack.security.fips_mode.enabled
istrue
, you cannot useSSLv2Hello
orSSLv3
. See FIPS 140-2. -
xpack.notification.email.ssl.verification_mode
-
(Static) Defines how to verify the certificates presented by another party in the TLS connection:
Valid values
-
full
-
Validates that the provided certificate: has an issue date that’s
within the
not_before
andnot_after
dates; chains to a trusted Certificate Authority (CA); has ahostname
or IP address that matches the names within the certificate. -
certificate
-
Validates the provided certificate and verifies that it’s signed by a
trusted authority (CA), but doesn’t check the certificate
hostname
. -
none
-
Performs no certificate validation.
Setting certificate validation to
none
disables many security benefits of SSL/TLS, which is very dangerous. Only set this value if instructed by Elastic Support as a temporary diagnostic mechanism when attempting to resolve TLS errors.
Defaults to
full
. -
-
xpack.notification.email.ssl.cipher_suites
-
(Static) Supported cipher suites vary depending on which version of Java you use. For example, for version 12 the default value is
TLS_AES_256_GCM_SHA384
,TLS_AES_128_GCM_SHA256
,TLS_CHACHA20_POLY1305_SHA256
,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
,TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256
,TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
,TLS_RSA_WITH_AES_256_GCM_SHA384
,TLS_RSA_WITH_AES_128_GCM_SHA256
,TLS_RSA_WITH_AES_256_CBC_SHA256
,TLS_RSA_WITH_AES_128_CBC_SHA256
,TLS_RSA_WITH_AES_256_CBC_SHA
,TLS_RSA_WITH_AES_128_CBC_SHA
.For more information, see Oracle’s Java Cryptography Architecture documentation.
Watcher Email TLS/SSL key and trusted certificate settings
editThe 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. A private key and certificate are optional and would be used if the server requires client authentication for PKI authentication.
PEM encoded files
editWhen using PEM encoded files, use the following settings:
-
xpack.notification.email.ssl.key
-
(Static) Path to a PEM encoded file containing the private key.
If HTTP client authentication is required, it uses this file. You cannot use this setting and
ssl.keystore.path
at the same time. -
xpack.notification.email.ssl.secure_key_passphrase
- (Secure) The passphrase that is used to decrypt the private key. Since the key might not be encrypted, this value is optional.
-
xpack.notification.email.ssl.certificate
-
(Static) Specifies the path for the PEM encoded certificate (or certificate chain) that is associated with the key.
This setting can be used only if
ssl.key
is set. -
xpack.notification.email.ssl.certificate_authorities
-
(Static) List of paths to PEM encoded certificate files that should be trusted.
This setting and
ssl.truststore.path
cannot be used at the same time.
Java keystore files
editWhen using Java keystore files (JKS), which contain the private key, certificate and certificates that should be trusted, use the following settings:
-
xpack.notification.email.ssl.keystore.path
-
(Static) The path for the keystore file that contains a private key and certificate.
It must be either a Java keystore (jks) or a PKCS#12 file. You cannot use this setting and
ssl.key
at the same time. -
xpack.notification.email.ssl.keystore.secure_password
- (Secure) The password for the keystore.
-
xpack.notification.email.ssl.keystore.secure_key_password
- (Secure) The password for the key in the keystore. The default is the keystore password.
-
xpack.notification.email.ssl.truststore.path
-
(Static) The path for the keystore that contains the certificates to trust. It must be either a Java keystore (jks) or a PKCS#12 file.
You cannot use this setting and
ssl.certificate_authorities
at the same time. -
xpack.notification.email.ssl.truststore.secure_password
- (Secure) Password for the truststore.
PKCS#12 files
editElasticsearch can be configured to use PKCS#12 container files (.p12
or .pfx
files)
that contain the private key, certificate and certificates that should be trusted.
PKCS#12 files are configured in the same way as Java keystore files:
-
xpack.notification.email.ssl.keystore.path
-
(Static) The path for the keystore file that contains a private key and certificate.
It must be either a Java keystore (jks) or a PKCS#12 file. You cannot use this setting and
ssl.key
at the same time. -
xpack.notification.email.ssl.keystore.type
-
(Static)
The format of the keystore file. It must be either
jks
orPKCS12
. If the keystore path ends in ".p12", ".pfx", or ".pkcs12", this setting defaults toPKCS12
. Otherwise, it defaults tojks
. -
xpack.notification.email.ssl.keystore.secure_password
- (Secure) The password for the keystore.
-
xpack.notification.email.ssl.keystore.secure_key_password
- (Secure) The password for the key in the keystore. The default is the keystore password.
-
xpack.notification.email.ssl.truststore.path
-
(Static) The path for the keystore that contains the certificates to trust. It must be either a Java keystore (jks) or a PKCS#12 file.
You cannot use this setting and
ssl.certificate_authorities
at the same time. -
xpack.notification.email.ssl.truststore.type
-
(Static)
Set this to
PKCS12
to indicate that the truststore is a PKCS#12 file. -
xpack.notification.email.ssl.truststore.secure_password
- (Secure) Password for the truststore.
Slack Notification Settings
editYou can configure the following Slack notification settings in
elasticsearch.yml
. For more information about sending notifications
via Slack, see Configuring Slack actions.
-
xpack.notification.slack.default_account
-
(Dynamic) Default Slack account to use.
If you configure multiple Slack accounts, you must either configure this setting or specify the Slack account to use in the
slack
action. See Configuring Slack Accounts.
-
xpack.notification.slack.account
-
Specifies account information for sending notifications via Slack. You can specify the following Slack account attributes:
-
secure_url
- (Secure, reloadable) The Incoming Webhook URL to use to post messages to Slack. Required.
-
message_defaults
-
Default values for Slack message attributes.
-
from
- (Dynamic) The sender name to display in the Slack message. Defaults to the watch ID.
-
to
- (Dynamic) The default Slack channels or groups you want to send messages to.
-
icon
- (Dynamic) The icon to display in the Slack messages. Overrides the incoming webhook’s configured icon. Accepts a public URL to an image.
-
text
- (Dynamic) The default message content.
-
attachment
- (Dynamic) 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.
-
-
Jira Notification Settings
editYou can configure the following Jira notification settings in
elasticsearch.yml
. For more information about using notifications
to create issues in Jira, see Configuring Jira actions.
-
xpack.notification.jira.default_account
-
(Dynamic) Default Jira account to use.
If you configure multiple Jira accounts, you must either configure this setting or specify the Jira account to use in the
jira
action. See Configuring Jira accounts.
-
xpack.notification.jira.account
-
Specifies account information for using notifications to create issues in Jira. You can specify the following Jira account attributes:
-
allow_http
-
(Dynamic)
If
false
, Watcher rejects URL settings that use a HTTP protocol. Defaults tofalse
. -
secure_url
- (Secure, reloadable) The URL of the Jira Software server. Required.
-
secure_user
- (Secure, reloadable) The name of the user to connect to the Jira Software server. Required.
-
secure_password
- (Secure, reloadable) The password of the user to connect to the Jira Software server. Required.
-
issue_defaults
- (Dynamic) Default fields values for the issue created in Jira. See Jira action attributes for more information. Optional.
-
PagerDuty Notification Settings
editYou can configure the following PagerDuty notification settings in
elasticsearch.yml
. For more information about sending notifications
via PagerDuty, see Configuring PagerDuty actions.
-
xpack.notification.pagerduty.default_account
-
(Dynamic) Default PagerDuty account to use.
If you configure multiple PagerDuty accounts, you must either configure this setting or specify the PagerDuty account to use in the
pagerduty
action. See Configuring PagerDuty accounts.
-
xpack.notification.pagerduty.account
-
Specifies account information for sending notifications via PagerDuty. You can specify the following PagerDuty account attributes:
-
name
- (Static) A name for the PagerDuty account associated with the API key you are using to access PagerDuty. Required.
-
secure_service_api_key
- (Secure, reloadable) The PagerDuty API key to use to access PagerDuty. Required.
-
-
event_defaults
-
Default values for PagerDuty event attributes. Optional.
-
description
-
(Dynamic)
A string that contains the default description for PagerDuty events.
If no default is configured, each PagerDuty action must specify a
description
. -
incident_key
- (Dynamic) A string that contains the default incident key to use when sending PagerDuty events.
-
client
- (Dynamic) A string that specifies the default monitoring client.
-
client_url
- (Dynamic) The URL of the default monitoring client.
-
event_type
-
(Dynamic)
The default event type. Valid values:
trigger
,resolve
,acknowledge
. -
attach_payload
-
(Dynamic)
Whether or not to provide the watch payload as context for
the event by default. Valid values:
true
,false
.
-
On this page
- General Watcher Settings
- Watcher HTTP TLS/SSL settings
- Watcher HTTP TLS/SSL key and trusted certificate settings
- PEM encoded files
- Java keystore files
- PKCS#12 files
- Email Notification Settings
- Watcher Email TLS/SSL settings
- Watcher Email TLS/SSL key and trusted certificate settings
- PEM encoded files
- Java keystore files
- PKCS#12 files
- Slack Notification Settings
- Jira Notification Settings
- PagerDuty Notification Settings