Add Elasticsearch User Settings

Change how Elasticsearch runs by providing your own user settings. User settings are appended to the elasticsearch.yml configuration file for your cluster and provide custom configuration options.

Tip

Some settings that could break your cluster if set incorrectly are blacklisted, such as certain zen discovery and security settings. Review the list of settings that are generally safe in cloud environments.

To add user settings:

  1. Log into the Elastic Cloud Console.
  2. On the Deployments page, select your deployment.

    Narrow the list of the deployments by name, ID, or choose from several other filters. Use a combination of them to further define the list.

  3. From your deployment menu, go to the Elasticsearch and then the Edit page.
  4. In the User Settings section, update the user settings.
  5. Click Save changes.

Supported Elasticsearch settings

Elastic Cloud supports the following Elasticsearch settings:

repositories.url.allowed_urls
Enables whitelisting of read-only URL repositories.
reindex.remote.whitelist
Whitelists the hosts that can be reindexed from remotely. Expects a YAML array of host:port strings. Consists of a comma-delimited list of host:port entries. Defaults to ["\*.io:*", "\*.com:*"].
script.painless.regex.enabled
Enables regular expressions for the Painless scripting language.
cluster.indices.close.enable

Enables closing indices in Elasticsearch version 2.2 and later. We strongly recommend leaving this set to false (the default). Closed indices are a data loss risk: If you close an index, it is not included in snapshots and you will not be able to restore the data. Similarly, closed indices are not included when you scale to a different cluster size or during failover operations. You might enable this setting temporarily in order to change the analyzer configuration for an existing index.

Caution

Closed indices are a data loss risk. Enable this setting only temporarily.

Circuit breaker settings

The following circuit breaker settings are supported:

indices.breaker.total.limit
Configures the parent circuit breaker settings.
indices.breaker.fielddata.limit
Configures the limit for the fielddata breaker.
indices.breaker.fielddata.overhead
Configures a constant that all field data estimations are multiplied with to determine a final estimation.
indices.breaker.request.limit
Configures the limit for the request breaker.
indices.breaker.request.overhead
Configures a constant that all request estimations are multiplied by to determine a final estimation.
X-Pack (for version 5.0 and later)

The following X-Pack settings are supported:

xpack.notification.slack
Configures Slack notification settings.
xpack.notification.hipchat
Configures HipChat notification settings.
xpack.notification.pagerduty
Configures PagerDuty notification settings.
xpack.watcher.trigger.schedule.engine
Defines when the watch should start, based on date and time.
xpack.notification.email.html.sanitization.*
Enables email notification settings to sanitize HTML elements in emails that are sent.
xpack.monitoring.collection.interval
Controls how often data samples are collected.
xpack.monitoring.history.duration
Sets the retention duration beyond which the indices created by a monitoring exporter will be automatically deleted.
xpack.watcher.history.cleaner_service.enabled
Controls whether old watcher indices are automatically deleted (requires 5.6.4 or greater).
Watcher and Marvel (for versions before 5.0)

The following Watcher and Marvel settings are supported:

watcher.actions.slack.service
Configures Slack notification settings.
watcher.actions.hipchat.service
Configures HipChat notification settings.
watcher.actions.pagerduty.service
Configures Configures PagerDuty notification settings.
marvel.agent.interval
Controls how often data samples are collected.
watcher.trigger.schedule.engine
Defines when the watch should start, based on date and time.
Tip

Remember to update user settings for alerts when performing a major version upgrade. For version 5.0 and later, the syntax is different when compared to earlier versions.

If a setting is not on this list, it cannot be set and will be rejected. Additional user settings might added in the future.