barnacles-elasticsearch v1.2.1

barnacles-elasticsearch

barnacles-elasticsearch writes IoT data to Elasticsearch.

barnacles-elasticsearch ingests a real-time stream of raddec & dynamb objects from barnacles, and spatem objects from chimps, which it writes to a given Elasticsearch instance. It couples seamlessly with reelyActive's Pareto Anywhere open source IoT middleware.

barnacles-elasticsearch is a lightweight Node.js package that can run on resource-constrained edge devices as well as on powerful cloud servers and anything in between.

Pareto Anywhere integration

A common application of barnacles-elasticsearch is to write IoT data from pareto-anywhere to a local or remote Elasticsearch database. Simply follow our Create a Pareto Anywhere startup script tutorial using the script below:

#!/usr/bin/env node

const ParetoAnywhere = require('../lib/paretoanywhere.js');

// Edit the options to specify the Elasticsearch instance
const BARNACLES_ELASTICSEARCH_OPTIONS = {};

// ----- Exit gracefully if the optional dependency is not found -----
let BarnaclesElasticsearch;
try {
  BarnaclesElasticsearch = require('barnacles-elasticsearch');
}
catch(err) {
  console.log('This script requires barnacles-elasticsearch.  Install with:');
  console.log('\r\n    "npm install barnacles-elasticsearch"\r\n');
  return console.log('and then run this script again.');
}
// -------------------------------------------------------------------

let pa = new ParetoAnywhere();
pa.barnacles.addInterface(BarnaclesElasticsearch,
                          BARNACLES_ELASTICSEARCH_OPTIONS);
pa.chimps.addInterface(BarnaclesElasticsearch, BARNACLES_ELASTICSEARCH_OPTIONS);

Options

barnacles-elasticsearch supports the following options:

For raddec events, all raddec toFlattened() options are supported. The default is { includePackets: false }.

By default barnacles-elasticsearch will connect and write to localhost:9200.

Connecting to an Elastic Cloud instance

Connecting to the Elastic Cloud is straightforward using the clientOptions as follows:

const clientOptions = {
    cloud: { id: "copy-paste from Elastic Cloud dashboard" },
    auth: {
        username: "pareto-anywhere",
        password: "password"
    }
}
barnacles.addInterface(BarnaclesElasticsearch, { clientOptions: clientOptions });

Connecting to a self-hosted instance

See the Elasticsearch JavaScript client API documentation on connecting to select the appropriate clientOptions for your instance.

Project History

• Version 1.1+ expects an Elasticsearch 8.x instance, but should be backwards-compatible with 7.x nonetheless
• Version 1.0 expects an Elasticsearch 7.x instance (see release-1.0 branch)

Contributing

Discover how to contribute to this open source project which upholds a standard code of conduct.

Security

Consult our security policy for best practices using this open source software and to report vulnerabilities.

License

MIT License

Copyright (c) 2019-2025 reelyActive

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.