Skip to content

Siddhi Store Elasticsearch

Jenkins Build Status GitHub Release GitHub Release Date GitHub Open Issues GitHub Last Commit License

The siddhi-store-elasticsearch extension is an extension to Siddhi that persists and retrieve events to/from Elasticsearch

For information on Siddhi and it's features refer Siddhi Documentation.

Download

  • Versions 3.x and above with group id io.siddhi.extension.* from here. This supports elastic search 7.x.x version and above (based on Siddhi 5.x.x).
  • Versions 2.x and above with group id org.wso2.extension.siddhi.* from here. This supports elastic search 7.x.x version (based on Siddhi 4.x.x).
  • Versions 1.5.x and above with group id io.siddhi.extension.* from here. This supports elastic search 6.x.x version (based on Siddhi 5.x.x).
  • Versions 1.x and lower with group id org.wso2.extension.siddhi.* from here. This supports elastic search 6.x.x version (based on Siddhi 4.x.x).

Latest API Docs

Latest API Docs is 3.2.2.

Features

  • elasticsearch (Sink)

    Elasticsearch sink implementation uses Elasticsearch indexing document for underlying data storage. The events that are published from the sink will be converted into elasticsearch index documents. The elasticsearch sink is connected to the Elastisearch server via the Elasticsearch Java High Level REST Client library. By using this sink, we can customize the json document before it's stored in the elasticsearch.

  • elasticsearch (Store)

    Elasticsearch store implementation uses Elasticsearch indexing document for underlying data storage. The events are converted to Elasticsearch index documents when the events are inserted into the elasticsearch store. Elasticsearch indexing documents are converted to events when the documents are read from Elasticsearch indexes. The internal store is connected to the Elasticsearch server via the Elasticsearch Java High Level REST Client library.

Prerequisites

  • Elasticsearch can be downloaded directly from href="https://www.elastic.co/downloads/elasticsearch" in zip, tar.gz, deb, or rpm packages.
  • Then install the version 6.2.4, usual Ubuntu way with dpkg.
     sudo apt-get update
     wget https://download.elastic.co/elasticsearch/release/org/elasticsearch/distribution/deb/elasticsearch/6.2.4/elasticsearch-6.2.4.deb
     sudo dpkg -i elasticsearch-6.2.4.deb

How To Install and Configure Elasticsearch on Ubuntu 16.04 - Also you can start the Elasticsearch server using docker image:

     docker run -p 9600:9200 -p 9700:9300 -e "discovery.type=single-node" -e ELASTIC_PASSWORD=MagicWord -d docker.elastic.co/elasticsearch/elasticsearch:6.2.4

Dependencies

There are no other dependencies needed for this extension.

Installation

For installing this extension on various siddhi execution environments refer Siddhi documentation section on adding extensions.

Support and Contribution

  • We encourage users to ask questions and get support via StackOverflow, make sure to add the siddhi tag to the issue for better response.

  • If you find any issues related to the extension please report them on the issue tracker.

  • For production support and other contribution related information refer Siddhi Community documentation.