enrise-esclient v0.1.5

Node.js esclient module

A simple wrapper around the elasticsearch client, optionally with enrise-logger integration.

Installation

NPM: npm install enrise-esclient --save
Yarn: yarn add enrise-esclient

Initialization and usage

Require and instantiate the client, where config is an optional object passed to elasticsearch:
const ESClient = new require('enrise-esclient')([config: Object]);

This instantiates an elasticsearch client with a KeepAlive agent.

Configuration

The only default configuration option this module sets is the createNodeAgent to connect with a KeepAlive agent. Also it has extra logging abstractions (below). For further instructions on configuring the client see the official elasticsearch documentation.

[log]

This module optionally supports passing an enrise-logger instance to the client. To use this, initialize the logger beforehand, and then pass an instance to the esclient upon instantiation:

const enriseClient = require('enrise-client');

// Initialize enrise logger
const logger = require('enrise-logger')();

// Instantiate elasticsearch client with an enrise-logger
const client = new enriseClient({
  log: logger.get('Elasticsearch')
});