|
1 |
| -# stream |
2 |
| -Flogo Stream Action |
| 1 | +<p align="center"> |
| 2 | + <img src ="https://raw.githubusercontent.com/TIBCOSoftware/flogo/master/images/flogo-ecosystem_streams.png" /> |
| 3 | +</p> |
| 4 | + |
| 5 | +<p align="center" > |
| 6 | + <b>Streams is a pipeline based, stream processing action for the Project Flogo Ecosystem</b> |
| 7 | +</p> |
| 8 | + |
| 9 | +<p align="center"> |
| 10 | + <img src="https://travis-ci.org/TIBCOSoftware/flogo.svg"/> |
| 11 | + <img src="https://img.shields.io/badge/dependencies-up%20to%20date-green.svg"/> |
| 12 | + <img src="https://img.shields.io/badge/license-BSD%20style-blue.svg"/> |
| 13 | + <a href="https://gitter.im/project-flogo/Lobby?utm_source=share-link&utm_medium=link&utm_campaign=share-link"><img src="https://badges.gitter.im/Join%20Chat.svg"/></a> |
| 14 | +</p> |
| 15 | + |
| 16 | +# Flogo Stream |
| 17 | + |
| 18 | +Edge devices have the potential for producing millions or even billions of events at rapid intervals, often times the events on their own are meaningless, hence the need to provide basic streaming operations against the slew of events. |
| 19 | + |
| 20 | +A native streaming action as part of the Project Flogo Ecosystem accomplishes the following primary objectives: |
| 21 | + |
| 22 | +- Enables apps to implement basic streaming constructs in a simple pipeline fashion |
| 23 | +- Provides non-persistent state for streaming operations |
| 24 | + - Streams are persisted in memory until the end of the pipeline |
| 25 | +- Serves as a pre-process pipeline for raw data to perform basic mathematical and logical operations. Ideal for feeding ML models |
| 26 | + |
| 27 | +Some of the key highlights include: |
| 28 | + |
| 29 | +😀 **Simple pipeline** construct enables a clean, easy way of dealing with streams of data<br/> |
| 30 | +⏳ **Stream aggregation** across streams using time or event tumbling & sliding windows<br/> |
| 31 | +🙌 **Join streams** from multiple event sources<br/> |
| 32 | +🌪 **Filter** out the noise with stream filtering capabilities<br/> |
| 33 | + |
| 34 | +## Getting Started |
| 35 | + |
| 36 | +We’ve made building powerful streaming pipelines as easy as possible. Develop your pipelines using: |
| 37 | + |
| 38 | +- A simple, clean JSON-based DSL |
| 39 | +- Golang API |
| 40 | + |
| 41 | +See the sample below of an aggregation pipeline (for brevity, the triggers and metadata of the resource has been omitted). Also don’t forget to check out the examples in the [project-flogo/stream](https://github.com/project-flogo/stream/tree/master/examples) repo. |
| 42 | + |
| 43 | +```json |
| 44 | + "stages": [ |
| 45 | + { |
| 46 | + "ref": "github.com/TIBCOSoftware/flogo-contrib/activity/aggregate", |
| 47 | + "settings": { |
| 48 | + "function": "sum", |
| 49 | + "windowType": "timeTumbling", |
| 50 | + "windowSize": "5000" |
| 51 | + }, |
| 52 | + "input": { |
| 53 | + "value": "=$.input" |
| 54 | + } |
| 55 | + }, |
| 56 | + { |
| 57 | + "ref": "github.com/TIBCOSoftware/flogo-contrib/activity/log", |
| 58 | + "input": { |
| 59 | + "message": "=$.result" |
| 60 | + } |
| 61 | + } |
| 62 | + ] |
| 63 | +``` |
0 commit comments