Package Exports

@nearform/stats-to-elasticsearch

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@nearform/stats-to-elasticsearch) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

stats-to-elasticsearch

Collect and send stats about your node.js process to elasticsearch.

This module exposes a function which initialises a connection to elasticsearch and creates a stats event emitter to gather stats to be sent via the connection.

Installation

npm i -s @nearform/stats-to-elasticsearch

Usage

const StatsToElastic = require('@nearform/stats-to-elasticsearch')
const statsToElastic = StatsToElastic({elaticsearchConfig: {...}, statsConfig: {...}})
statsToElastic.start()

API

StatsToElastic(opts)

Returns: An object configured with an open connection to elasticsearch and a stats event emitter to gather stats from.

Opts is an object which can contain the following properties:

elasticsearchConfig: a configuration object which is passed to the elasticsearch module when initialising theconnection. Configured with the following defaults:

  {
    host: 'localhost:9200',
    log: 'error',
    maxRetries: Number.MAX_SAFE_INTEGER,
    sniffOnStart: true,
    keepAlive: true,
    sniffOnConnectionFault: true
  }

statsConfig: A configuration object which is passed to the stats module when initialising the stats event emitter. Configured to use the standard stats defaults.

The object which was returned contains the following methods:

statsToElastic.start()

Starts the stats event emitter emitting stats to be sent to elasticsearch

statsToElastic.stop()

Stops the stats event emitter emitting stats

License

Apache 2.0