Skip to content

Commit

Permalink
Added version compatiblity
Browse files Browse the repository at this point in the history
  • Loading branch information
jeffyactive committed Jun 10, 2022
1 parent 0341100 commit fb55fad
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
barnacles-elasticsearch
=======================

[Elasticsearch](https://www.elastic.co/products/elasticsearch) interface for [barnacles](https://github.com/reelyactive/barnacles/) open source software. Stores _raddec_ and/or _dynamb_ events in Elasticsearch. We believe in an open Internet of Things.
[Elasticsearch](https://www.elastic.co/products/elasticsearch) interface for [barnacles](https://github.com/reelyactive/barnacles/) open source software. Stores _raddec_ and/or _dynamb_ events in Elasticsearch.

- Version 1.1 expects an Elasticsearch v8.x instance, but should be backwards-compatible with v7.x nonetheless
- Version 1.0 expects an Elasticsearch v7.x instance (see release-1.0 branch)


Installation
Expand Down Expand Up @@ -40,6 +43,7 @@ __barnacles-elasticsearch__ supports the following options:
| client | null | An instantiated Elasticsearch client |
| printErrors | false | Print errors to the console (for debug) |
| eventsToStore | { raddec: {}, dynamb: {} } | See default event-specific properties below |
| esVersion | 8 | Can be forced to 7 if required |

For raddec events, all [raddec](https://github.com/reelyactive/raddec/) toFlattened() options are supported. The default is { includePackets: false }.

Expand Down

0 comments on commit fb55fad

Please sign in to comment.