Skip to content

Latest commit

 

History

History
104 lines (68 loc) · 4.54 KB

README.md

File metadata and controls

104 lines (68 loc) · 4.54 KB
Raw

barnacles-elasticsearch

Elasticsearch interface for barnacles open source software. Stores raddec and/or dynamb and/or spatem events in Elasticsearch.

  • 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)

Installation

npm install barnacles-elasticsearch

Hello barnacles-elasticsearch

The following code will write simulated raddec data to Elasticsearch running a local server (default port 9200). The simulated data is provided by barnowl which is typically run in conjunction with barnacles. Install the barnowl, barnacles and barnacles-elasticsearch packages using npm before running the code.

const Barnowl = require('barnowl');
const Barnacles = require('barnacles');
const BarnaclesElasticsearch = require('barnacles-elasticsearch');

let barnowl = new Barnowl();
barnowl.addListener(Barnowl, {}, Barnowl.TestListener, {});

let barnacles = new Barnacles({ barnowl: barnowl });
barnacles.addInterface(BarnaclesElasticsearch, { /* See options below */ });

Options

barnacles-elasticsearch supports the following options:

Property Default Description
node "http:https://localhost:9200" Elasticsearch node
clientOptions null Object of parameters for client instantiation
client null An instantiated Elasticsearch client
printErrors false Print errors to the console (for debug)
eventsToStore { raddec: {}, dynamb: {}, spatem: {} } See default event-specific properties below
esVersion 8 Can be forced to 7 if required

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.

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-2024 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.