Siddhi is a Streaming and Complex Event Processing engine that listens to events from data streams, detects complex conditions described via a Streaming SQL language, and triggers actions. This repo contains necessary source code which creates the Siddhi runner and Siddhi tooling distributions by embedding Siddhi library in it.
Siddhi maintains two distributions as Siddhi-Runner and Siddhi-Tooling distribution.
-
Siddhi-Runner distribution bundles the Siddhi runtime which runs the Siddhi logic in a production environment.
-
Siddhi-Tooling distribution bundles the tooling editor profile which can be used for developing, testing and debugging Siddhi applications before moving to production.
- Oracle JDK 8 or OpenJDK 8 (Java 8 should be used for building in order to support both Java 8 and Java 11 at runtime)
- Maven 3.5.x version
- Node.js 8.x.x or above
-
Get a clone or download source from Github
git clone https://github.com/siddhi-io/distribution.git
-
Run the Maven command
mvn clean install
from the root directory -
Find the Siddhi distributions in the following directories,
Runner: runner/target
Tooling: tooling/target
Download the latest released distributions from here
-
Extract the Siddhi runner distribution.
-
Navigate to the <RUNNER_HOME>/bin directory and issue the following command:
For Windows: worker.bat
For Linux: ./worker.shIn order to start the runner with only one Siddhi application deployed, use the -Dfile property with the path to the relevant Siddhi file as shown below.
For Windows: worker.bat -Dfile=<SIDDHI_FILE_PATH>
For Linux : ./worker.sh -Dfile=<SIDDHI_FILE_PATH>
Download the latest released distributions from here
- Extract the Siddhi tooling distribution.
- Navigate to the <TOOLING_HOME>/bin directory and issue the following command:
For Windows: editor.bat
For Linux: ./editor.sh - Access the Editor UI using the following URL.
http://localhost:<EDITOR_PORT>/editor (e.g: https://localhost:9390/portal )
We encourage you to report issues. However, please consider searching the existing issues in GitHub and communicating in Siddhi-Dev Google Group if you are unsure if it is a bug before filing a new issue.
To file a non-security issues:
-
Click the Issues tab in the GitHub repository,
-
Click the New Issue button,
-
Fill out all sections in the issue template and submit.
Siddhi-Dev Google Group Group is the main Siddhi project discussion forum for developers.
Users can use Siddhi-User Google Group to raise any queries and get some help to achieve their use cases.
StackOverflow also can be used to get support, and GitHub for issues and code repositories.