Elasticsearch Settings


Elasticsearch Settings

Opster Team

Nov 2020


In addition to reading this guide, run the free Elasticsearch Health Check-Up. Get actionable recommendations that can improve performance and prevent incidents (does not require any installation). Among the dozens of checks included are: shards sizes, search errors, thread pools, management queue size, circuit breakers and many more. Join over 700 users who use this free tool.

Settings in Elasticsearch

What it is:

In ElasticSearch, you can configure cluster-level settings, node-level settings and index level settings. Here we discuss each of them.

A. Cluster settings

These settings can be either persistent, meaning they apply across restarts, or transient, meaning they won’t survive a full cluster restart. If a transient setting is reset, the first one of these values that is defined is applied:

  • the persistent setting
  • the setting in the configuration file
  • the default value

The order of precedence for cluster settings is:

  1. transient cluster settings
  2. persistent cluster settings
  3. settings in the elasticsearch.yml configuration file

Examples:

An example of persistent cluster settings update:

PUT /_cluster/settings
{
    "persistent" : {
        "indices.recovery.max_bytes_per_sec" : "500mb"
    }
}

An example of a transient update:

PUT /_cluster/settings
{
    "transient" : {
        "indices.recovery.max_bytes_per_sec" : "40mb"
    }
}

B. Index settings

These are the settings that are applied to individual indices. There is an API to update index level settings.

Examples:

The following API call will set the number of replica shards to 5 for my_index index.

PUT /my_index/_settings
{
    "index" : {
        "number_of_replicas" : 5    
     }
}

To revert a setting to the default value, use null.

PUT /my_index/_settings
{
    "index" : {
        "refresh_interval" : null
    }
}

C. Node settings

These settings apply to nodes. Nodes can fulfill different roles. These include the master, data, and coordination roles. Node settings are set through the elasticsearch.yml file for each node. 

Examples:

  • Setting a node to be a data node (in the elasticsearch.yml file) 
node.data: true
  • Disabling the ingest role for the node (which is enabled by default)
node.ingest: false

For production clusters, you will need to run each type of node on a dedicated machine with two or more instances of each, for HA  (minimum three for master nodes).

Notes and good things to know:

  • Learning the cluster settings and index settings is important, it can spare you a lot of trouble. For example, if you are going to ingest huge amount of data into an index, then if the number of replica shards are set , for example at 5 replica shards, the indexing process will be super slow because the data will be replicated at the same time it is indexed. What you can do to speed up indexing is to set the replica shards to 0 by updating the settings, and set it back to the original number when indexing is done, using the settings API.

  • Another useful example of using cluster-level settings is when a node has just joined the cluster and the cluster is not assigning any shards to the node. Although shard allocation is enabled by default on all nodes, someone may have disabled shard allocation at some point (for example, in order to perform a rolling restart), and forgot to re-enable it later. To enable shard allocation, you can update the Cluster Settings API:

PUT /_cluster/settings{"transient":{"cluster.routing.allocation.enable":"all"}}
  • It’s better to set cluster-wide settings with Settings API instead of with the elasticsearch.yml file and to use the file only for local changes. This will keep the same setting on all nodes. But if you define different settings on different nodes by accident using the elasticsearch.yml configuration file, it is hard to notice these discrepancies.

  • See also: Recoveries


Related log errors to this ES concept


Failed to apply cluster settings
Not updating settings for the index because upgraded of some primary shards failed
Failed to apply settings
Failed to prepareCommit settings for
Logger.warnbuilder.toString;
Updating from to
Reload failed for plugin
Updated breaker settings field data:
Updated breaker settings for accounting requests:
Updated breaker settings request:
Updated breaker settings for in-flight requests:
Ignoring existing unknown setting: with value ; archiving

< Page: 1 of 5 >




Improve Elasticsearch Performance

Run The Analysis