stream

package module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 5, 2018 License: BSD-3-Clause Imports: 9 Imported by: 0

README

Streams is a pipeline based, stream processing action for the Project Flogo Ecosystem

Flogo Stream

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.

A native streaming action as part of the Project Flogo Ecosystem accomplishes the following primary objectives:

  • Enables apps to implement basic streaming constructs in a simple pipeline fashion
  • Provides non-persistent state for streaming operations
    • Streams are persisted in memory until the end of the pipeline
  • Serves as a pre-process pipeline for raw data to perform basic mathematical and logical operations. Ideal for feeding ML models

Some of the key highlights include:

😀 Simple pipeline construct enables a clean, easy way of dealing with streams of data
Stream aggregation across streams using time or event tumbling & sliding windows
🙌 Join streams from multiple event sources
🌪 Filter out the noise with stream filtering capabilities

Getting Started

We’ve made building powerful streaming pipelines as easy as possible. Develop your pipelines using:

  • A simple, clean JSON-based DSL
  • Golang API

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 repo.

  "stages": [
    {
      "ref": "github.com/TIBCOSoftware/flogo-contrib/activity/aggregate",
      "settings": {
        "function": "sum",
        "windowType": "timeTumbling",
        "windowSize": "5000"
      },
      "input": {
        "value": "=$.input"
      }
    },
    {
      "ref": "github.com/TIBCOSoftware/flogo-contrib/activity/log",
      "input": {
        "message": "=$.result"
      }
    }
  ]

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActionFactory

type ActionFactory struct {
	// contains filtered or unexported fields
}

func (*ActionFactory) Init

func (f *ActionFactory) Init() error

func (*ActionFactory) New

func (f *ActionFactory) New(config *action.Config) (action.Action, error)

type Settings

type Settings struct {
	PipelineURI   string `md:"required"`
	GroupBy       string
	OutputChannel string
}

we can generate json from this! - we could also create a "validate-able" object from this

type StreamAction

type StreamAction struct {
	// contains filtered or unexported fields
}

func (*StreamAction) IOMetadata

func (s *StreamAction) IOMetadata() *data.IOMetadata

func (*StreamAction) Metadata

func (s *StreamAction) Metadata() *action.Metadata

func (*StreamAction) Run

func (s *StreamAction) Run(context context.Context, inputs map[string]*data.Attribute, handler action.ResultHandler) error

Directories

Path Synopsis
activity
aggregate module
filter module
service
telemetry module
trigger
streamtester module

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL