Config options

host or hosts

String, String[], Object[] — Specify the hosts that this client will connect to. If sniffing is enabled, or you call client.sniff(), this list will be used as seeds to discover the rest of your cluster.

The value(s) are passed to the Host constructor. Host objects can help enforce path-prefixes, default headers and query strings, and can be helpful in making more intelligent selection algorithms; Head over to the Host docs for more information.

httpAuth

String — Specifies the default http auth as a String with username and password separated by a colon (eg. user:pass). Applies to any host defined in the original config, and any hosts discovered while sniffing.

log

String, String[], Object, Object[], Constructor — Unless a constructor is specified, this sets the output settings for the bundled logger. See the section on configuring-logging[logging] for more information.

apiVersion

String — Change the API that they client provides, specify the major version of the Elasticsearch nodes you will be connecting to.

plugins

Function[] — Plugin instantiators that will be called when the Client initializes. Each function is called in order with the arguments Constructor, config, and components.

Constructor is the class that will be newed up to create the client instance. It’s prototype contains the api methods that correlate to the apiVersion requested.

config is the config object that was passed to the elasticsearch.Client constructor.

components is a map of the internal classes for this version of the elasticsearch client. The values on this object are listed here.

sniffOnStart

Boolean — Should the client attempt to detect the rest of the cluster when it is first instantiated?

sniffInterval

Number, false — Every n milliseconds, perform a sniff operation and make sure our list of nodes is complete.

sniffOnConnectionFault

Boolean — Should the client immediately sniff for a more current list of nodes when a connection dies?

maxRetries

Integer — How many times should the client try to connect to other nodes before returning a ConnectionFault error.

requestTimeout

Number — Milliseconds before an HTTP request will be aborted and retried. This can also be set per request.

deadTimeout

Number — Milliseconds that a dead connection will wait before attempting to revive itself.

pingTimeout

Number — Milliseconds that a ping request can take before timing out.

maxSockets

Number — Maximum number of sockets to allow per host.

keepAlive

Boolean — Should the connections to the node be kept open forever? This behavior is recommended when you are connecting directly to Elasticsearch.

keepAliveInterval

Number — How often, in milliseconds, should TCP KeepAlive packets be sent over sockets being kept alive. Only relevant if keepAlive is set to true.

keepAliveMaxFreeSockets

Number — Maximum number of inactive sockets to keep connected to a node. Only relevant if keepAlive is set to true.

keepAliveFreeSocketTimeout

Number — Sets inactive sockets to timeout after milliseconds of inactivity. Only relevant if keepAlive is set to true.

suggestCompression

Boolean — The client should inform Elasticsearch, on each request, that it can accept compressed responses. In order for the responses to actually be compressed, you must enable http.compression in Elasticsearch. See these docs for additional info.

connectionClass

String, Constructor — Defines the class that will be used to create connections to store in the connection pool. If you are looking to implement additional protocols you should probably start by writing a Connection class that extends the ConnectionAbstract.

sniffedNodesProtocol

String — Defines the protocol that will be used to communicate with nodes discovered during sniffing.

ssl

Object — An object defining HTTPS/SSL configuration to use for all nodes. The properties of this mimic the options accepted by tls.connect() with the exception of rejectUnauthorized, which defaults to false allowing self-signed certificates to work out-of-the-box.

Additional information available in SSL and Authentication.

selector

String, Function — This function will be used to select a connection from the ConnectionPool. It should received a single argument, the list of "active" connections, and return the connection to use. Use this selector to implement special logic for your client such as preferring nodes in a certain rack or data-center.

To make this function asynchronous, accept a second argument which will be the callback to use. The callback should be called Node-style with a possible error like: cb(err, selectedConnection).

defer

Function — Override the way that the client creates promises. If you would rather use any other promise library this is how you’d do that. Elasticsearch.js expects that the defer object has a promise property (which will be returned to promise consumers), as well as resolve and reject methods.

nodesToHostCallback

Function - This function will receive the list of nodes returned from the _cluster/nodes API during a sniff operation. The function should return an array of objects which match the specification for the hosts config.

createNodeAgent

Function — Override the way that the client creates node.js Agent[https://nodejs.org/api/http.html#http_class_http_agent] objects. The value of this property will be executed every time a new Node is added to the client (either from the initial seed or from sniffing) and can return any value that node’s http(s) module accepts as agent: configuration.

The function is called with two arguments, first an HttpConnector[http://github.com/spalger/elasticsearch-js/blob/master/src/lib/connectors/http.js] object and the second the config object initially passed when creating the client.