flink-siddhi - GitLite

KO | EN

gitlite — search

#python #react #android #machine-learning #linux #nodejs #java #awesome #kubernetes #vue #awesome-list #ios #mcp #openai

flink-siddhi

(★ 247)

A CEP library to run Siddhi within Apache Flink™ Streaming Application (Not maintained)

파일 탐색기

최종 버전 다운로드 (.zip)

- - maven.yml
- pom.xml
- pom.xml
- README.md
- - checkstyle.xml
  - scalastyle-config.xml
  - suppressions.xml
.gitignore
.travis.yml
LICENSE
pom.xml
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/haoch/flink-siddhi

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd flink-siddhi

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Maven (Java)

보통 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
JDK (Java) Java 프로젝트를 빌드/실행하려면 필요합니다.
Maven mvn 명령어를 쓰기 위한 빌드 도구입니다.

cd core

이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.

mvn clean install

Maven으로 의존성 설치와 빌드를 진행합니다.

✅ BUILD SUCCESS 메시지가 뜨면 성공입니다. target/ 폴더에 결과물이 생성됩니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

flink-siddhi
============

[![Travis CI](https://api.travis-ci.org/haoch/flink-siddhi.svg)](https://travis-ci.org/haoch/flink-siddhi)
[![Clojars Project](https://img.shields.io/clojars/v/com.github.haoch/flink-siddhi_2.11.svg)](https://clojars.org/com.github.haoch/flink-siddhi_2.11)

> A light-weight library to run [Siddhi CEP](https://github.com/wso2/siddhi) within [Apache Flink](https://github.com/apache/flink) streaming application.

Siddhi CEP is a lightweight and easy-to-use Open Source Complex Event Processing Engine (CEP) released as a Java Library under `Apache Software License v2.0`. 
Siddhi CEP processes events which are generated by various event sources, analyses them and notifies appropriate complex events according to the user specified queries.

This project is mainly to provide a light-weight library to easily run Siddhi CEP within flink streaming application.

## Features

* Integrate Siddhi CEP as an stream operator (i.e. `TupleStreamSiddhiOperator`), supporting rich CEP features like
  * Filter
  * Join
  * Aggregation
  * Group by
  * Having
  * Window
  * Conditions and Expressions
  * Pattern processing
  * Sequence processing
  * Event Tables
  * ...
* Provide easy-to-use Siddhi CEP API to integrate Flink DataStream API (See `SiddhiCEP` and `SiddhiStream`)
  * Register Flink DataStream associating native type information with Siddhi Stream Schema, supporting POJO,Tuple, Primitive Type, etc.
  * Connect with single or multiple Flink DataStreams with Siddhi CEP Execution Plan
  * Return output stream as DataStream with type intelligently inferred from Siddhi Stream Schema
* Integrate siddhi runtime state management with Flink state (See `AbstractSiddhiOperator`)
* Support siddhi plugin management to extend CEP functions. (See `SiddhiCEP#registerExtension`)

## Development

### Prerequisites

* Java (Version: `1.8`)
* Apache Maven
* Apache Flink (Version: `1.7.0`)

### Clone

git clone git@github.com:haoch/flink-siddhi.git

### Building

mvn clean install -DskipTests
   
### Testing

mvn clean test

## Usage and API

* Add [`com.github.haoch:flink-siddhi`](https://clojars.org/com.github.haoch/flink-siddhi_2.11) in project dependencies:

<dependencies>
                <dependency>
                        <groupId>com.github.haoch</groupId>
                        <artifactId>flink-siddhi_2.11</artifactId>
                        <version>LATEST</version>
                </dependency>
        </dependencies>
        
        <repositories>
                <repository>
                        <id>clojars</id>
                        <url>http://clojars.org/repo/</url>
                </repository>
        </repositories>
 
* Execute [`SiddhiQL`](https://docs.wso2.com/display/CEP300/Introduction+to+Siddhi+Query+Language) with `SiddhiCEP` API, for example:

StreamExecutionEnvironment env = StreamExecutionEnvironment.getExecutionEnvironment();
        SiddhiCEP cep = SiddhiCEP.getSiddhiEnvironment(env);
        
        cep.registerExtension("custom:plus",CustomPlusFunctionExtension.class);
        
        cep.registerStream("inputStream1", input1, "id", "name", "price","timestamp");
        cep.registerStream("inputStream2", input2, "id", "name", "price","timestamp");
        
        DataStream<Tuple5<Integer,String,Integer,String,Double>> output = cep
             .from("inputStream1").union("inputStream2")
             .cql( 
             "from every s1 = inputStream1[id == 2] "
             + " -> s2 = inputStream2[id == 3] "
             + "select s1.id as id_1, s1.name as name_1, s2.id as id_2, s2.name as name_2 , custom:plus(s1.price,s2.price) as price"
             + "insert into outputStream")
            .returns("outputStream");
        
        env.execute();
     
  > For more examples, please see [`org.apache.flink.contrib.siddhi.SiddhiCEPITCase`](https://github.com/haoch/flink-siddhi/blob/master/core/src/test/java/org/apache/flink/streaming/siddhi/SiddhiCEPITCase.java)

## Documentations
* Site: https://haoch.github.io/flink-siddhi/
* Wiki: https://github.com/haoch/flink-siddhi/wiki
* Siddhi Query Language: https://docs.wso2.com/display/CEP300/Introduction+to+Siddhi+Query+Language
* Apache Flink: http://flink.apache.org/

## Support and Contact
* Issues: https://github.com/haoch/flink-siddhi/issues
* Documents: https://github.com/haoch/flink-siddhi/wiki

## Contributors

* Hao Chen [@haoch](https://github.com/haoch) (Author, hao AT apache DOT org)
* Aparup Banerjee [@aparup](https://github.com/aparup)
* Blues Zheng [@kisimple](https://github.com/kisimple)
* [@aagupta1](https://github.com/aagupta1)
* [@wittyameta](https://github.com/wittyameta)
* Jinhu Wu [@wujinhu](https://github.com/wujinhu)
* Pi Jing [@tammypi](https://github.com/tammypi)
* Jayant Ameta [@wittyameta](https://github.com/wittyameta)
* Drona [@Dr0na](https://github.com/Dr0na)

## Contribution

Welcome to make contribution to code or document by [sending a pull request](https://github.com/haoch/flink-siddhi/pulls), or [reporting issues or bugs](https://github.com/haoch/flink-siddhi/issues).

## License

Licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0). More details, please refer to [LICENSE](LICENSE) file.